-
Install Git : https://git-scm.com/
-
Install Node.js : https://nodejs.org
-
Clone the project :
$ git clone https://github.com/LCluber/Ch.js.git
-
Install project dependencies :
$ cd <project-directory> $ npm i
-
create a branch following these instructions
-
build the library :
$ npm run build
-
test the library :
$ npm run test -
commit your following conventional commits rules :
$ npm run commit
This command will guide you to write correct conventional commits and help us keep a clear changelog file.
- dist/
- src/
- tests/
| Purpose | Choice | Motivation |
|---|---|---|
| repository | Github | the world’s largest community of developers to discover, share, and build better software |
| package manager | npm | default node.js package manager |
| type checking | TypeScript | static type checking along with the latest ECMAScript features |
| module bundler | Rollup.js | advanced module bundler for ES6 modules |
| unit testing | Jest | delightful testing with a focus on simplicity |
| deployment | Travis | test and deploy with confidence |