Skip to content

taroninak/account-management-system

Repository files navigation

Account Management System

Description

This is a sample project to provide an API of account management system

It is built with Nest framework

Installation

$ npm install

Running the app

Create .env file like this

DB_SCHEMA=public
DB_HOST=loclahost
DB_NAME=postgres
DB_USERNAME=postgres
DB_PASSWORD=password
DB_SSL=false

Run migrations and seeders

npm run migration:run

Run application

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Also, if you have docker-compose installed on your system you can just run

docker-compose up

Documentation

OpenApi Documentation is available at https://account-managment-system.herokuapp.com/docs

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Contributors

License

MIT licensed