Project Requirements:
- Make
- nvm (to manage node versions)
- node version 18.13
nvm install 18.13nvm use 18.13- verify using
$ node --version
Required: Create a .env file at the root of the project and fill with the required values.
- Start the local server:
$ make develop
- Visit graphql playground: http://localhost:3000/offline/graphql
- We use various testing frameworks to run unit tests, including mocha, chai, mongo-unit, and supertest.
- You may look at the *.spec.ts files under test/graphql/ for unit test examples.
- Run
make testto run all unit tests.
- Before pushing your changes to github, run
make formatandmake test-allto confirm all tests pass. - ALWAYS push your changes to a separate branch and open a PR when your changes are ready to be reviewed.
- Request a review from a team member.
- Once the PR is approved, merge into main.