NestJS Starter Kit

A comprehensive and production-ready NestJS backend solution for modern web applications

• Description
• Features
• Tech Stack
• Installation
• Running the App
• Environment Variables
• API Documentation
• Project Structure
• Contributing

This project is a NestJS-based starter kit that provides a solid foundation for modern web applications. Built with TypeScript, it includes essential features like authentication, authorization, database management, and API documentation.

• NestJS Framework - TypeScript-based, scalable backend architecture
• PostgreSQL + TypeORM - Powerful database integration and ORM support
• Modular Structure - Clean and maintainable code organization

• JWT Authentication - Access & Refresh token system
• Role-Based Authorization - Admin/User role management
• Password Hashing - Secure password storage with Bcrypt
• Guards & Decorators - Endpoint-level security

• Swagger UI - Automatic API documentation and testing interface
• OpenAPI 3.0 - Standard API specification
• Interactive Testing - Live API testing through Swagger interface

• Global Exception Handling - Centralized error management
• Response Transformation - Standard API response format
• Validation Pipes - Input data validation
• Class Validator - DTO-level validation

• CORS Support - Cross-origin resource sharing
• Environment Configuration - Environment-based configuration
• Logging - Detailed logging system

• Node.js (v22 or higher)
• PostgreSQL (v17 or higher) OR Docker
• npm or yarn

1. Run PostgreSQL with Docker

sudo docker run --name nest-starter-kit -e POSTGRES_USER=username -e POSTGRES_PASSWORD=password -p 5432:5432 -d postgres

2. Access Docker container

docker exec -it nest-starter-kit bash

3. Connect to PostgreSQL

psql -U username

4. Create database

CREATE DATABASE nest_db;

1. Clone the repository

git clone https://github.com/necatiboga/nest-starter-kit
cd nest-starter-kit

2. Install dependencies

npm install

3. Set up environment variables

cp .env.example .env
# Edit the .env file with your configuration

4. Create database (if not using Docker)

# Create database in PostgreSQL
createdb nest-db

# Development mode
npm run start:dev

# Production mode
npm run start:prod

# Debug mode
npm run start:debug

After running the application:

• API Base URL: http://localhost:3000/api
• Swagger UI: http://localhost:3000/swagger

Set up the following variables in your .env file:

# Database Configuration
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_USER=your_username
DATABASE_PASSWORD=your_password
DATABASE_NAME=nest-db

# JWT Configuration
JWT_SECRET=your_jwt_secret_key
JWT_EXPIRES_IN=1h
JWT_REFRESH_SECRET=your_refresh_secret_key
JWT_REFRESH_EXPIRES_IN=30d

Swagger UI interface is available at http://localhost:3000/swagger

• POST /api/auth/register - User registration
• POST /api/auth/login - User login
• POST /api/auth/refresh-token - Token refresh
• POST /api/auth/logout - Logout

• GET /api/users - Get users list (Admin only)
• GET /api/users/profile - Get profile information
• GET /api/users/:id - Get user by id (Admin only)
• POST /api/users - Create new user (Admin only)
• PATCH /api/update-profile - Update own profile
• PATCH /api/users/:id - Update user by id (Admin only)
• DELETE /api/users/:id - Delete user (Admin only)

src/
├── common/              # Shared components
│   ├── filters/         # Exception filters
│   ├── interceptors/    # Response interceptors
│   └── interfaces/      # Common interfaces
├── config/              # Configuration files
│   └── database/        # Database configuration
├── modules/             # Application modules
│   ├── auth/            # Authentication module
│   │   ├── decorators/  # Auth decorators
│   │   ├── dto/         # Data Transfer Objects
│   │   ├── guards/      # Auth guards
│   │   └── strategies/  # Passport strategies
│   └── users/           # Users module
│       ├── dto/         # User DTOs
│       └── entities/    # User entity
├── app.module.ts        # Main application module
└── main.ts              # Application entry point

1. Fork this repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

This project is licensed under the MIT License. See the LICENSE file for details.

Feel free to open an issue or submit a pull request for any questions or suggestions.

⭐ If you like this project, don't forget to give it a star!