Description

Project Management App

Prerequisites

• Node.js
• PostgreSQl
• Git

Installation

Local Setup

# Clone the repository:
$ git clone https://github.com/PatriciaChebet/asha-backend.git

# Run the command below to install the dependencies:
$ npm install

Database Setup

Create a postgres database on your local machine.

Create a .env file on the root directory of the project folder and populate it with DB_PORT, DB_HOST, DB_USERNAME, DB_PASSWORD and DB_NAME variables.

# Run the migration named: SetupMigrations:
$ npm run migration:run

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

API Documentation

Access the API documentation on the api endpoint:

url:port/api