NL APIs
Installation
$ npm i
Running the app
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
Contributions Guide
- Clone and set up the repo. Please use
node-16
as your node version. Check out nvm to manage node versions.
- Create a
.env
file and copy the env vars from this doc. We have set up a staging environment to start with the project quickly.
- Run
npm run start:dev
and contribute!
Notes:
- Our branching strategy has a
development
branch that is used as the base branch for all PRs. Periodically features that are tested by QA and merged to development are moved to master
branch and a release is created.
- Please follow this commit guidelines
- All PRs should be made to the
development
branch instead of the default master
branch.