https://github.com/slicequeue/nestjs-sequelize-boilerplate
slicequeue's nestjs + sequelize boilerplate!
https://github.com/slicequeue/nestjs-sequelize-boilerplate
boilerplate nestjs
Last synced: about 2 months ago
JSON representation
slicequeue's nestjs + sequelize boilerplate!
- Host: GitHub
- URL: https://github.com/slicequeue/nestjs-sequelize-boilerplate
- Owner: slicequeue
- Created: 2020-12-12T12:49:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-21T07:30:35.000Z (over 3 years ago)
- Last Synced: 2025-04-04T19:29:16.900Z (about 1 year ago)
- Topics: boilerplate, nestjs
- Language: TypeScript
- Homepage:
- Size: 231 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
nestjs 이용한 보일러 플레이트 + Sequelize 설정
## Installation
```bash
$ npm install
```
## Running the app
환경 설정 파일을 build 한 경로 내부에 설정해야함
dist/config/ 경로에 아래 파일을 생성한다.
..env
설정 내용은 다음과 같다.
```dotnetcli
HOST=<호스트주소 ex) localhost>
PORT=<서버포트>
SECRET_KEY=<암호화키값>
SALT_ROUND=<단방향암호화_라운드수>
SWAGGER_BASEPATH=<스웨거호스트값>
DB_ID=<데이터베이스계정아이디>
DB_PWD=<데이터베이스계정비밀번호>
DB_PORT=<옵션:데이터베이스포트:디폴트시_3306>
DB_DATABASE=<옵션:데이터베이스스키마:디폴트시_mariadb>
SEQUELIZE_DIALECT=<옵션:사용할데이터베이스DIALECT:디폴트시_mariadb>
```
- 위 설정을 사용은 configService 이용하여 처리함
- 이 값들을 이용하여 데이터베이스 상세 설정 가능
```dotnetcli
... 해당 부분 config/index.ts 참고,
이 설정을 통해 Sequelize 를 통한 접속 설정 가능
```
- 더불어 SEQUELIZE_DIALECT 관련하여 해당 dialect 지정 또는 디폴트 사용시
- npm install --save
## 실행법
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## docker
```bash
# docker build
$ docker build -t .
# docker run
$ docker run
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Stay in touch
- Author - 김진황