Contributing

Want to contribute? Great! Check the guidelines below.

Tech

node.js - evented I/O for the backend
Typescript - a strict syntactical superset of JavaScript, and adds optional static typing to the language
Jest - a testing framework
ESLint: a fully pluggable tool for identifying and reporting on patterns in JavaScript
Prettier: an opinionated code formatter

Open your favorite Terminal and run these commands:

cd node-talisman

npm install

Run eslint on all ts files:

$ npm run lint

Run typescript typechecking:

$ npm run typecheck

Run unit tests:

$ npm test

Run unit tests in watch mode:

$ npm run test:watch

Run unit tests with coverage:

$ npm run test:coverage

Run lint and typechecking and tests:

$ npm run check

Run prettier formatting:

$ npm run format