Thank you for considering to help this project.
We welcome all support, whether on bug reports, feature requests, code, design, reviews, tests, documentation, and more.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Clone the project on your computer. You will also need Node and nvm.
nvm install
# Then, install all project dependencies.
npm install
Everything mentioned in the installation process should already be done.
# Make sure you use the right node version.
nvm use
# Start the server and the development tools.
npm run start
# Runs linting.
npm run lint
# Re-formats all of the files in the project (with Prettier).
npm run format
# Run tests in a watcher.
npm run test:watche
# Open the coverage report with:
npm run report:coverage
# Open the build report with:
npm run report:build
# View other available commands with:
npm run
This project uses Prettier, ESLint, and TypeScript. All code should always be checked with those tools.