Boilerplate for Nest.js, PostgreSQL, Prisma and Swagger

⚡ An open-source Boilerplate for NestJS developers who want to build a high-performance, maintainable, and enjoyable app: NestJS, TypeScript, ESLint, Prettier, Docker, PostgreSQL, Prisma, Jest, and Swagger.

🔥 Features

• NestJS for building scalable server-side applications
• Type checking with TypeScript
• Linter with ESLint
• Code Formatter with Prettier
• Containerization with Docker
• Database management with PostgreSQL and Prisma
• API Documentation with Swagger
• Testing with Jest

👨🏻‍💻 Getting Started

Prerequisites

• Node.js (>=20.x)
• npm or yarn
• Docker (optional, for containerized setup)

Installation

1. Clone the repository:

   bash
   git clone https://github.com/ByronMike/nestjs-template.git
   cd nestjs-template
   

2. Install dependencies:

npm install
# or
yarn install

3. Running the database

docker compose up

4. Running the app

# development
$ npm run start

# watch mode (preferred)
$ npm run start:dev

# production mode
$ npm run start:prod

📘 Check the swagger

http://localhost:4000/api#/

🧪 Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

🚀 Deploy to Production

You can build and start the app in production mode with:

npm run build
npm run start:prod
# or
yarn build
yarn start:prod

💖 Contributing

1. Fork this repository.
2. Create your branch: git checkout -b my-remarkable-contribution.
3. Commit your changes: git commit -m 'feat: add my remarkable contribution'.
4. Push to the branch: git push origin my-remarkable-contribution.

📝 License

Licensed under the MIT License, Copyright © 2024

See LICENSE for more information.

---

Made with ❤️ by Michaël Auger My Contact