After clonning the project cd inside root directory of the project and copy .env.sample
and named it to .env
cp .env.sample .env
for the smtp part of the environment variables, this project is using sendgrid. All of the fields will be provided when integrating using smtp relay on sendgrid account.
MAILER_HOST=smtp.sendgrid.net // default host
MAILER_USER=apikey // default user
MAILER_PASSWORD=
MAILER_FROM=
Run docker compose with ~$: docker compose up
.
Requirements:
- Redis v6+
- Postgres v14+
- node v14+
Running the API server:
- npm i
- npm run start:dev
Run unit test:
npm t
Run unit test with coverage:
npm run test:cov
npm run test:e2e
# By Module (subject | course | module | content | enrollment | user)
npm run test:e2e -- course
While running the API, navigate to http://localhost:3000/docs