🚀 NestJS + GraphQL + MongoDB Starter

A professional, scalable boilerplate for building GraphQL APIs with NestJS and MongoDB

✨ Features

• 🔥 NestJS - A progressive Node.js framework
• ⚡️ GraphQL with Apollo Server - Code-first approach
• 📦 MongoDB integration with Mongoose
• 🧩 Modular architecture
• 📏 ESLint + Prettier for consistent code style
• 🚦 Class Validator for DTO validation
• 🔄 Conventional Commits for structured commit messages

📚 Tech Stack

🚀 Getting Started

Prerequisites

• Node.js (v14 or newer)
• MongoDB (local or Atlas connection)
• Yarn or NPM

Installation

1. Clone the repository

git clone https://github.com/Ridho894/nestjs-graphql-mongo-starter.git
cd nestjs-graphql-mongo-starter

2. Install dependencies

npm install
# or
yarn install

3. Environment Setup

Create a .env file in the root directory with the following variables:

# Server
PORT=3000

# MongoDB
MONGO_URI=mongodb://localhost:27017/nestjs-gql-mongo

# JWT
JWT_SECRET=your_jwt_secret_key
JWT_EXPIRES=1d

4. Start the development server

npm run start:dev
# or
yarn start:dev

Your GraphQL API will be available at http://localhost:3000/graphql

📊 GraphQL Playground

Once your application is running, you can access the GraphQL Playground to interact with your API:

Screenshot: GraphQL Playground interface showing query execution

Sample Queries

Here's a simple query you can try in the playground:

{
  users {
    _id
    name
    email
  }
}

🧰 Development Commands

Command	Description
npm run build	Builds the application
npm start	Starts the application
npm run start:dev	Starts the application in watch mode
npm run start:debug	Starts with debugging
npm run start:prod	Starts in production mode
npm run lint	Lints the code
npm run test	Runs tests
npm run test:watch	Runs tests in watch mode
npm run test:cov	Shows test coverage

🏗️ Project Structure

nestjs-gql-mongo-starter/
├── src/
│   ├── config/            # Configuration files and constants
│   ├── graphql/           # GraphQL specific files
│   ├── modules/           # Feature modules
│   │   └── users/         # User module example
│   │       ├── dto/       # Data Transfer Objects
│   │       ├── schemas/   # Mongoose schemas
│   │       ├── users.module.ts
│   │       ├── users.resolver.ts
│   │       └── users.service.ts
│   ├── app.module.ts      # Main application module
│   └── main.ts           # Application entry point
├── public/
│   └── screenshots/       # Screenshots for documentation
├── test/                  # Testing utilities
├── .env                   # Environment variables (create this)
├── .gitignore             # Git ignore file
├── nest-cli.json          # NestJS CLI configuration
├── package.json           # Dependencies and scripts
├── tsconfig.json          # TypeScript configuration
└── README.md              # Documentation

💻 Features Implementation

• GraphQL API
  • Code-first approach using decorators
  • Schema auto-generation
  • Resolvers for queries and mutations

📝 Commit Message Convention

This project follows Conventional Commits for clear and structured commit messages. This helps in maintaining a standardized commit history and automated versioning.

Commit Message Format

Each commit message consists of a header, an optional body, and an optional footer:

<type>(<scope>): <short summary>
│       │             │
│       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
│       │
│       └─⫸ Commit Scope (optional): modules|config|schema
│
└─⫸ Commit Type: feat|fix|docs|style|refactor|test|chore|ci|build|perf

Types

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
• refactor: A code change that neither fixes a bug nor adds a feature
• test: Adding missing tests or correcting existing tests
• chore: Changes to the build process or auxiliary tools
• ci: Changes to CI configuration files and scripts
• build: Changes that affect the build system or external dependencies
• perf: Performance improvements

Examples

feat(auth): add JWT authentication
fix(users): resolve issue with user creation
docs(readme): update installation instructions

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

👏 Acknowledgments

• NestJS Documentation
• GraphQL Documentation
• Mongoose Documentation