A modern NestJS starter boilerplate built with best practices in mind. Ideal for scalable backend applications with support for microservices, Swagger documentation, and developer tooling.

• ⚙️ Structured environment variables
• 📄 Swagger API documentation
• 🛣️ Short/alias import paths (@/)
• 🔒 Pre-commit checks using Husky + Lint-Staged
• 🧩 Microservices-ready architecture
• 🔐 Auth module with JWT
• 🧱 Scalable modular folder structure
• 🛢️ Support for both TypeORM and Prisma (choose your ORM)
• 🔍 ESLint for code linting and maintaining code quality
• 📝 Conventional Commit setup for standardized commit messages

• NestJS - Scalable Node.js framework
• TypeORM - ORM for PostgreSQL
• PostgreSQL - Relational database
• JWT - JSON Web Token for authentication
• Swagger - API documentation
• Husky + Lint-Staged - Git hooks for code quality
• Dotenv - Environment configuration

apps/
├── auth-api/
│   └── src/
│       ├── common/
│       ├── config/
│       ├── dto/
│       ├── entities/
│       ├── shared/
│       ├── main.ts
│       ├── auth-api.controller.ts
│       ├── auth-api.service.ts
│       └── auth-api.module.ts
├── product-api/
│   └── src/
│       ├── common/
│       ├── config/
│       ├── dto/
│       ├── entities/
│       ├── shared/
│       ├── main.ts
│       ├── product-api.controller.ts
│       ├── product-api.service.ts
│       └── product-api.module.ts

# Server
PORT=3000

# JWT
JWT_SECRET=your_jwt_secret
JWT_EXPIRES_IN=3600s

# Database
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=postgres
DB_PASSWORD=password
DB_NAME=nestjs_db

git clone https://github.com/Ganiramadhan/nestjs-starter.git
cd nestjs-starter

yarn install

yarn prepare

yarn start:auth-api:dev
yarn start:product-api:dev

• http://localhost:3000/api-docs

The project supports NestJS microservices (e.g., TCP, Redis, NATS, etc.).
Example microservice bootstrap (main.ts):

async function bootstrap() {
  const app = await NestFactory.createMicroservice(AppModule, {
    transport: Transport.TCP,
    options: {
      host: '127.0.0.1',
      port: 8877,
    },
  });
  await app.listen();
}

This starter uses Husky + Lint-Staged to enforce code quality:

• ✅ Auto-format staged files
• ✅ Prevent committing unformatted code

// package.json
"lint-staged": {
    "**/*.ts": ["eslint --fix"]
  },

To maintain a standardized commit message format, this project follows the Conventional Commit specification. This helps with consistency and automating versioning and changelog generation.

Here are the most common types of commit messages:

• feat: A new feature.
• fix: A bug fix.
• chore: Routine tasks like dependency updates or build processes.
• docs: Documentation updates.
• style: Code formatting or style changes (no functional changes).
• refactor: Code changes that neither fix bugs nor add features but improve the codebase.
• test: Adding or modifying tests.

• feat(auth): add JWT authentication
• fix(auth): resolve token expiration issue
• docs(readme): update installation guide
• chore(deps): update prisma version

For more details, please refer to the Conventional Commits Specification.

MIT © 2025 NestJS Starter