Run Locally

Pre requisites:

• PostgreSQL Installed

Log into pgsql and initialize the database

CREATE DATABASE school-admin;

Clone the project

  git clone https://gitlab.com/a2507/school-admin-backend

Go to the project directory

  cd school-admin-backend

Create environment variables file

touch src/.env

Edit the .env file with the following variables

PORT=3000
PGUSER=^YOUR POSTGRES USERNAME^ (default "postgres")
PGPASSWORD=^YOUR POSTGRES PASSWORD^ (default "password")
PGHOST=localhost
PGPORT=5432
PGDATABASE=school-admin
JWT_SECRET=TS2Uukypxof12DzT2eAGB24iIg0=
JWT_EXPIRESIN=4h

Install dependencies

  npm install

Start the server in development mode

  npm run start dev

Read the docs at http://localhost:3000/api/docs