README.md

Before you start...

1. Install Node.js Version 14.x or higher! and npm 7.6x or higher!

2. Install MongoDB

Available Scripts

In the project directory, you can run:

npm install

Installs all the node package dependencies.

npm install --only-dev

Installs all the of developer dependencies.

npm start

Starts and runs the node server using nodemon.

npm test

Starts and runs the unit test suite and shows results.

Configuring Services with Environment Variables

In order to use our services you'll need to create a .env in the root folder. Once created you'll populate it with secrets given to you by the repo maintainers:

.env:

# MongoDB
MONGO_URI=YOUR MONGO URI

# AWS
AWS_ACCESS_KEY_ID=YOUR AWS ACCESS KEY ID
AWS_SECRET_ACCESS_KEY=YOUR AWS SECRET ACCESS KEY
JWT_SECRET=ANY RANDOM STRING
SENDGRID_API_KEY=YOUR SENGGRID API KEY