mathamel/renovation_api

Description

A Demo REST API for Renovation Projects

Project setup

Run locally - make sure you have PostgreSQL installed and running

# Copy the Env file
$ cp .env.sample .env
# Edit .env with your database credentials
$ nano .env

# Install packages
$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Resources

Complete Documentation - Vitepress

$ npm run docs:build 
# or
$ npm run docs:dev

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

Author - Mathieu Hamel](https://github.com/mathamel)

License

Nest is MIT licensed.