Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tak-bro/nestjs-typeorm-boilerplate
NestJS + TypeORM + Fastify + Serverless Framework Boilerplate
https://github.com/tak-bro/nestjs-typeorm-boilerplate
boilerplate boilerplate-template fastify minimal nest nestjs serverless serverless-framework typeorm
Last synced: 16 days ago
JSON representation
NestJS + TypeORM + Fastify + Serverless Framework Boilerplate
- Host: GitHub
- URL: https://github.com/tak-bro/nestjs-typeorm-boilerplate
- Owner: tak-bro
- License: mit
- Created: 2020-05-07T05:32:46.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2020-11-19T14:29:16.000Z (about 4 years ago)
- Last Synced: 2024-12-02T08:54:12.688Z (21 days ago)
- Topics: boilerplate, boilerplate-template, fastify, minimal, nest, nestjs, serverless, serverless-framework, typeorm
- Language: TypeScript
- Homepage:
- Size: 935 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Minimal Boilerplate for NestJS + TypeORM
> NestJS + TypeORM + Fastify + Serverless Framework Boilerplate
## Prerequisite
- [Docker](https://www.docker.com/)
- [NestJS](https://nestjs.com/)
## Usage
### Installation
```bash
$ 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](https://github.com/tak-bro/nestjs-typeorm-boilerplate/tree/develop/src/modules/dummy)** folder to getting started with implementing simple REST API
## Running the app
```bash
# 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
```bash
# 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](https://github.com/tak-bro/nestjs-typeorm-boilerplate/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](https://env-tak.github.io/)
### License
The MIT License (see the [LICENSE](https://github.com/tak-bro/nestjs-typeorm-boilerplate/blob/develop/LICENSE) file for the full text)