Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.45 KB

README.md

File metadata and controls

29 lines (21 loc) · 1.45 KB

scrum-management-backend

A containerized REST API for the Command project managment app.

The PostgreSQL database schema looks like this:

scrum-managmenet-backend-model pgerd

How to Install

If you don't already have Docker desktop, [download from here] (https://docs.docker.com/desktop/install/mac-install/). Fork and install dependencies with npm install.

The schema for the PostgreSQL will be automatically created by the Sequelize migrations on first run.

You will need setup and configure enviornment variables for Auth0, PostgreSQL database, and for the Sendgrid email API. Follow links for instructions.

Your enviornemnt variables should include the following:

DATABASE_URL='database url'
AUDIENCE='Your host url'
ISSUER='Auth0 issuer'
SECRET='Optional secret if you want to enable direct authorization not federated by Auth0'
SENDGRID_API_KEY='sendgrid api key'
RDS_DB_HOST='aws rds host'
RDS_DB_USER='user'
RDS_DB_PASS='pass'
RDS_DB_PORT='5432 for PostgreSQL'
RDS_DB_NAME='db name'

After its configured, You can run the service locally using docker build --tag <your-tag> and docker run --rm --name <image-name> -p 3001:3001 -e CONNECTIONSTRING=<db-connection-string>