- Clone this repository
- Run
npm install
- Run
npm run prepare
to install the husky hooks
Commands:
npm start
: to run on prod modenpm run dev
: to run on development modenpm run test
to run testsnpm run test:watch
to run tests on watch modenpm run format
: to format src folder with prettiernpm run lint
: to analyze code and fix problems in src folder with eslint
Git Hooks
commit-msg
: check if commit message satisfies the commitlint standard, otherwise the commit cannot be done.pre-commit
: check if files in src are error free according to the eslint rules, otherwise the commit cannot be done.pre-push
: runs the tests, but if the tests fail the push to remote repository cannot be done.
- TypeScript: TypeScript is a strongly typed programming language that builds on JavaScript.
- eslint: code static analyzer to quickly find problems.
- prettier: code formatter with support for many languages.
- jest: delightful JavaScript Testing Framework with a focus on simplicity.
- commitlint: lint commit messages.
- husky: modern native git hooks made easy.
- ts-node-dev: development tool for Node.js compatible with typescript that automatically restarts the node process when a file is modified.