Skip to content

Commit

Permalink
fix: update the Node.js version in package.json>engines (#98)
Browse files Browse the repository at this point in the history
chrishutchinson authored Jun 20, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent ad6d05a commit 3e43b23
Showing 14 changed files with 7,954 additions and 22 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ Additionally, a base class allows you to create your own renderers. See more in

CardKit requires a configuration object in order to render an image. Each renderer (CardKitDOM and CardKitServer) uses this configuration and converts it into an output. Below are simple implementations for CardKit depending on your use case.

In addition to these, you may also want to try the [CardKit Yeoman Generator](https://www.github.com/times/generator-cardkit), which can help you scaffold an entire project in just a few moments. It brings with it the latest version of CardKit, a recommended directory structure, and a build process that helps you get your CardKit project deployed. There is also a [JSFiddle](https://jsfiddle.net/chrishutchinson/16tLs2ta/) that you can fork and edit for quick in-browser testing without touching the command line.
In addition to these, you may also want to try the [CardKit Yeoman Generator](https://www.github.com/times/generator-cardkit), which can help you scaffold an entire project in just a few moments. It brings with it the latest version of CardKit, a recommended directory structure, and a build process that helps you get your CardKit project deployed. There is also a [JSFiddle](https://jsfiddle.net/chrishutchinson/16tLs2ta/) that you can fork and edit for quick in-browser testing without touching the command line.

### Previous versions

2 changes: 1 addition & 1 deletion docs/code/Card.html
Original file line number Diff line number Diff line change
@@ -1155,7 +1155,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/CardKit.html
Original file line number Diff line number Diff line change
@@ -3487,7 +3487,7 @@ <h5>Parameters:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/CardKitDOM.html
Original file line number Diff line number Diff line change
@@ -1775,7 +1775,7 @@ <h4 class="name" id="rerender"><span class="type-signature"></span>rerender<span
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/CardKitServer.html
Original file line number Diff line number Diff line change
@@ -853,7 +853,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/SVGToImage.html
Original file line number Diff line number Diff line change
@@ -1907,7 +1907,7 @@ <h5>Parameters:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/cardkit.js.html
Original file line number Diff line number Diff line change
@@ -284,7 +284,7 @@ <h1 class="page-title">cardkit.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
10 changes: 5 additions & 5 deletions docs/code/index.html
Original file line number Diff line number Diff line change
@@ -59,12 +59,14 @@
<li><a href="#cardkitserver"><code>CardKitServer</code></a>: A server renderer, that allows you to take an instance of CardKit and render it into an image on a Node.js server</li>
</ul>
<p>Additionally, a base class allows you to create your own renderers. See more in the <a href="#custom-renderers">Custom Renderers</a> section.</p>
<p><strong>For version 1, see the <a href="https://github.com/chrishutchinson/cardkit/tree/v1-master"><code>v1-master</code></a> branch</strong></p>
<h2>Installation</h2>
<p><code>$ npm install cardkit --save</code></p>
<h2>Usage</h2>
<p>CardKit requires a configuration object in order to render an image. Each renderer (CardKitDOM and CardKitServer) uses this configuration and converts it into an output. Below are simple implementations for CardKit depending on your use case.</p>
<p>In addition to these, you may also want to try the <a href="https://www.github.com/times/generator-cardkit">CardKit Yeoman Generator</a>, which can help you scaffold an entire project in just a few moments. It brings with it the latest version of CardKit, a recommended directory structure, and a build process that helps you get your CardKit project deployed. There is also a <a href="https://jsfiddle.net/chrishutchinson/16tLs2ta/">JSFiddle</a> that you can fork and edit for quick in-browser testing without touching the command line.</p>
<h3>Previous versions</h3>
<p>For <strong>version 1</strong>, see the <a href="https://github.com/chrishutchinson/cardkit/tree/v1-main"><code>v1-main</code></a> branch.</p>
<p>For <strong>version 2</strong>, see the <a href="https://github.com/chrishutchinson/cardkit/tree/v2-main"><code>v2-main</code></a> branch.</p>
<h4>Yeoman generator</h4>
<pre><code>$ npm install -g yo generator-cardkit
$ yo cardkit
@@ -280,10 +282,8 @@ <h2>Custom Fonts</h2>
// ...
};
</code></pre>
<h2>Upgrading from v1.x</h2>
<p>Upgrading from v1.x to v2 should be a fairly straightforward process if you haven't made any major modifications to the v1.x user interface. Your configuration object from v1.x should be compatible with v2 with a few minor tweaks. Specific variations are available in the Wiki.</p>
<h2>Running locally</h2>
<p>CardKit currently requires Node.js 8, which you can install using <code>nvm</code> and running:</p>
<p>CardKit currently requires Node.js 14, which you can install using <code>nvm</code> and running:</p>
<pre><code>$ nvm use
</code></pre>
<p>To run a sample UI locally, run: <code>$ npm start</code></p>
@@ -302,7 +302,7 @@ <h2>Tests</h2>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/renderers_dom_SVGToImage.js.html
Original file line number Diff line number Diff line change
@@ -320,7 +320,7 @@ <h1 class="page-title">renderers/dom/SVGToImage.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/renderers_dom_dom.js.html
Original file line number Diff line number Diff line change
@@ -224,7 +224,7 @@ <h1 class="page-title">renderers/dom/dom.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/renderers_server_server.js.html
Original file line number Diff line number Diff line change
@@ -118,7 +118,7 @@ <h1 class="page-title">renderers/server/server.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
2 changes: 1 addition & 1 deletion docs/code/renderers_shared_Card.js.html
Original file line number Diff line number Diff line change
@@ -409,7 +409,7 @@ <h1 class="page-title">renderers/shared/Card.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -12,22 +12,21 @@
"url": "https://github.com/chrishutchinson/cardkit.git"
},
"engines": {
"node": ">14"
"node": ">=14"
},
"scripts": {
"test": "istanbul cover --dir test/coverage _mocha -- --require @babel/register --require ignore-styles",
"jsdoc": "jsdoc -c ./jsdoc.config.json -d ./docs/code -t ./node_modules/minami --verbose -R ./README.md",
"demo": "webpack --env=dist-docs",
"docs": "npm run jsdoc",
"docs": "jsdoc -c ./jsdoc.config.json -d ./docs/code -t ./node_modules/minami --verbose -R ./README.md",
"start": "webpack-dev-server -d --content-base ./src --hot --open",
"dist": "npm run build",
"build": "echo \"[NOTICE] This task will build ALL CardKit versions\"; echo \"[LOG] Building DOM library\"; npm run build-dom; echo \"[LOG] Building server library\"; npm run build-server; echo \"[LOG] Building core library\"; npm run build-core; echo \"[LOG] Building DOM <script> library\"; npm run build-dom-script; echo \"[LOG] Building core <script> library\"; npm run build-core-script",
"dist": "yarn build",
"build": "echo \"[NOTICE] This task will build ALL CardKit versions\"; echo \"[LOG] Building DOM library\"; yarn build-dom; echo \"[LOG] Building server library\"; yarn build-server; echo \"[LOG] Building core library\"; yarn build-core; echo \"[LOG] Building DOM <script> library\"; yarn build-dom-script; echo \"[LOG] Building core <script> library\"; yarn build-core-script",
"build-dom": "webpack --env=dist-dom",
"build-server": "webpack --env=dist-server",
"build-core": "webpack --env=dist-core",
"build-dom-script": "webpack --env=dist-dom-script",
"build-core-script": "webpack --env=dist-core-script",
"test-and-build-all": "npm test; npm run build; npm run demo; npm run docs"
"test-and-build-all": "yarn test; yarn build; yarn demo; yarn docs"
},
"author": "Chris Hutchinson <[email protected]>",
"license": "MIT",
7,933 changes: 7,933 additions & 0 deletions yarn.lock

Large diffs are not rendered by default.

0 comments on commit 3e43b23

Please sign in to comment.