NOTE

There are some services and APIS we can only use with free amount, please register these service on you own and replace the api key inside .env.example :

HOW TO BUILD

# clone repository
$ git clone https://github.com/phuochungus/HomeLand_Apartment_Management_BE.git
$ cd HomeLand_Apartment_Management_BE

# install dependencies
$ npm install

# pull necessary images
$ docker compose pull

# rename .env.example to .env
# you might change some variable if you need to connect to real redis, postgresql or supabase project
$ cp .env.example .env

HOW TO RUN

# docker compose include redis and postgresql
# if your local machine have redis or postgresql, please turn off all in order to run properly
$ docker compose up -d

# start supabase local
$ npx supabase start

# start nestjs
$ npm run start:dev

# you might need to send HTTP GET to this endpoint to create empty database and S3 storage:
http://localhost:3000/seed/init

HOW TO CLOSE (GRACEFULLY)

On terminal where Nestjs running press Ctrl + C

# stop docker containers
$ docker compose stop

# stop supabase
$ npx supabase stop

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

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

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

License

Nest is MIT licensed.