1.4 KiB
Contributing
License Agreement
By providing any kind of contribution to this project, you must agree and be legally entitled to provide them for use and distribution as a part of this project wholly under the same terms as in the original included license.
Contributions
Contributions by pull request or issues are welcome. Please ensure they follow the same style and architecture as the rest of the code. Use npm run lint before submitting. Please do not include any changes to the files in the build directory.
Before contributing please read the license agreement described at the beginning of this document.
Building
To build you must first install node.js, then run
npm install
which will install the required build dependencies, then run
npm run dev
which will run the development server and opens http://localhost:8000/ in your browser. Any changes you make to the source will automatically rebuild and reload the page.
Commands
The following development commands can be run at the terminal
- npm run dev
runs development server - npm run build
creates a release build - npm run lint
runs the linter - npm run test
runs the tests - npm run compare
compares the output of examples for current source against release build - npm run doc
builds the documentation