# clone this repository
$ git clone https://github.com/programercopas/nest-starter-project.git

# run npm install
$ npm install

# copy .env.example
$ cp .env.example env

# input environment config in .env file
# Apps
APP_PORT=3000

# Database Connection
CONN_TYPE=mysql
CONN_HOST=localhost
CONN_PORT=3306
CONN_USERNAME=root
CONN_PASSWORD=secret
CONN_DATABASE=nest_starter
CONN_LOGGING=false

# Redis Config
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=

# run redis in local
$ redis-server

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

# copy docker-compose.yml.example
$ cp docker-compose.yml.example docker-compose.yml

# run docker-compose
$ docker compose up -d  

# stop docker-compose
$ docker compose down -v 

# create migration file
$ npm run migration:create ./src/migrations/CreateTableExample

# run migrations file
$ npm run migration:migrate

# run migration revert
$ npm run migration:revert

# generate migration from entities
$ npm run migration:generate ./src/migrations/GenerateAllEntities

src
---api
------config
--------config.module.ts
--------config.service.ts
--------migration.typeorm.config.ts
------database
--------entties
--------migrations
--------database.module.ts
---constants
---dto
---helpers
---interface
---services
---main.ts

# LIST EXAMPLE
GET LIST [GET]    : http://localhost:3000/example?page=1&limit=10&order=firstName:ASC&email=

# FIND BY ID
FIND ONE [GET]    : http://localhost:3000/example/31526f91-f0d3-4a86-b5f5-34b00f7d0ecb

# CREATE EXAMPLE
CREATE   [POST]   : http://localhost:3000/example

# UPDATE EXAMPLE
UPDATE   [PUT]    : http://localhost:3000/example/31526f91-f0d3-4a86-b5f5-34b00f7d0ecb

# DELETE EXAMPLE
DELETE   [DELETE] : http://localhost:3000/example/31526f91-f0d3-4a86-b5f5-34b00f7d0ecb

# see detail in swagger
http://localhost:3000/docs