redapple-api-rewrite v1.0.0

For Developers

Setup workspace

• Download redis client (Recommended: brew install redis)
• Run redis-server to start local redis server.
• Clone repository
• Open terminal and cd to the directory
• Create a config folder in the src directory and add a dev.env file to it.
• In the dev.env file add configs as described in the Env Config section below.
• Run npm install
• Run npm run dev

Env Config

Here is a example dev.env file:

PORT=[YOUR_PORT]
MONGO_URI="[YOUR_MONGO_URI]"

JWT_SECRET="[JWT_SIGNING_SECRET]"

AUTH0_JWKS_URI=https://{AUTH0_URL}/.well-known/jwks.json
AUTH0_AUDIENCE={AUTH_0_AUDIENCE}
AUTH0_ISSUER=https://{AUTH0_URL}

AWS_SNS_ACCESS_KEY={SNS_ACCESS}
AWS_SNS_SECRET_KEY={SNS_SECRET}

Scripts

Run these scripts with npm run [SCRIPT_NAME]

• dev - Starts the server with nodemon (For hot reloading).
• build:docs - Builds the static api docs.

Important Todo

• Add more validations to schemas
• Add helmet