Skip to content

Latest commit

 

History

History
122 lines (94 loc) · 4.05 KB

README.md

File metadata and controls

122 lines (94 loc) · 4.05 KB

Welcome to Nest Onion Boilerplate 👋

build with love build with love

Greenkeeper badge CircleCI Gitmoji code style: prettier Version License: MIT Twitter: Beaussart_n

A starter kit for a production ready Nestjs application

What's in it

Feat Techno Status
Database Typeorm (pluged for now on postgresql) Done
Env config Dotenv + Joi for validation Done
Docker dockerfile Done
Swagger Done
Testing Jest + supertest In progress
Auth Nest Passport + jwt In progress
Metrics Prometheus In progress
Logger Winston In progress
Code generator Hygen In progress
S3 / GCP storage To do
Mailing To do
Search with algolia To do
Search with Elastic To do
Error Reporting Sentry To do

And any features requested by future users.

Installation

$ yarn install

Running the app

# development
yarn start

# watch mode
yarn start:dev

# production mode
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

Lints

$ yarn format:check

$ yarn lint

Generate

$ yarn generate module with-crud --name myModule

Author

👤 Nicolas Beaussart [email protected]

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!


This README was generated with ❤️ by readme-md-generator