Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 956 Bytes

README.md

File metadata and controls

35 lines (24 loc) · 956 Bytes
Raw

FYP BACKEND

This README would normally document whatever steps are necessary to get your application up and running.

What is this repository for?

  • This repo is for SHIPEASE final year project backend
  • Version 1.0.0
  • Postgres db

Database Schema

My Image

How do I get set up?

  • Clone this repository by git clone https://github.com/Final-Year-Project-ShipEase/backend.git
  • Install dependencies by running npm install
  • Create .env file in folder
  • Paste data from Confluence file in env files
  • Download postgres and pg admin
  • To create database, run npm run db:create
  • To start server, run npm run start

Contribution guidelines

  • Writing tests
  • Code review
  • Other guidelines

Who do I talk to?