A library template project
- code written in typescript
- testing done with Tape. consider switching to tape-promise for async tests.
- test files are inside the src library
- prettier and eslint
- circleci setup for automatic testing
to install a development environment, you need to have node.js git installd.
Then, git clone this repo locally and run:
$ npm install
$ npm test
and that's it, you've just installed the development environment!
This project is written with VSCode in mind. specifically configured for these extensions: dbaeumer.vscode-eslint, esbenp.prettier-vscode. also recommended CircleCI
npm run test
execute all tests.
npm run clean
Removes any built code and any built executables.
npm run build
Cleans, then builds the library.
Your built code will be in the ./dist/ directory.