NestJS Quickstart Template

A feature-rich starter template for building efficient and scalable server-side applications with NestJS.

About This Template

This repository is a starter template for building applications with the Nest framework. It comes pre-configured with a set of essential tools to streamline your development process.

Features

• NestJS: A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
• Prisma: Next-generation Node.js and TypeScript ORM.
• Biome: A high-performance toolchain for web development, used here for linting and formatting.
• Husky: Modern native Git hooks made easy.
• PNPM: Fast, disk space-efficient package manager.

Getting Started

Prerequisites

• Node.js (v18 or newer)
• pnpm

Installation

1. Use this repository as a template by clicking the "Use this template" button on GitHub.
2. Clone your newly created repository:

   git clone https://github.com/your-username/your-new-repo.git

3. Navigate to the project directory and install dependencies:

   cd your-new-repo
   pnpm install

4. Set up your environment variables by copying the example file:

   cp .env.example .env

   Note: Remember to fill in your database connection details in the .env file.

Development

To compile and run the project in development mode:

# watch mode
$ pnpm run start:dev

The application will be available at http://localhost:3000.

Other Scripts

# production build
$ pnpm run build

# start in production mode
$ pnpm run start:prod

Testing

To run the test suites:

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

Deployment

When you're ready to deploy your NestJS application, refer to the official deployment documentation for guidance on best practices.

License

This project is MIT licensed.