Check out the API doc here, generated by [apidoc
]
To run this app, you'll need to create a .env
file in the root project directory to define the required environment variables. The file sample.env
is included as a template:
PORT=3000
DB_URI=?
JWT_SECRET="this is a secret"
JWT_EXPIRE_IN_SECS=600
AWS_ACCESS_KEY_ID=?
AWS_SECRET_ACCESS_KEY=?
AWS_REGION=?
EMAIL_SENDER=?
Here are some descriptions for the less obvious ones:
DB_URI
- path to mongodbJWT_SECRET
- key for signing tokensJWT_EXPIRE_IN_SECS
- time to expiry for generated tokensEMAIL_SENDER
- email address to send system message from
Test cases written with mocha
and supertest
, with help from faker
. To in the console simply run:
$ npm i
$ npm test