Minimal Boilerplate for NestJS + TypeORM

NestJS + TypeORM + Fastify + Serverless Framework Boilerplate

Prerequisite

• Docker
• NestJS

Usage

Installation

$ git clone [email protected]:tak-bro/nestjs-typeorm-boilerplate.git
$ cd nestjs-typeorm-boilerplate

# rename .env.example to .env
$ mv .env.example .env

# rename env-example folder to env for serverless environment
$ mv env-example/ env/

$ npm install

Template Module

• Please refer dummy folder to getting started with implementing simple REST API

Running the app

# run MySQL on docker
$ docker-compose up -d

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

# serverless-offline mode
$ npm run start:sls

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Troubleshooting

Please follow this guidelines when reporting bugs and feature requests:

1. Use GitHub Issues board to report bugs and feature requests (not our email address)
2. Please always write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it.

Thanks for understanding!

Stay in touch

• Author

License

The MIT License (see the LICENSE file for the full text)