ddd-bun-api-boilerplate

🥈Silver

Production-ready multi-tenant SaaS API boilerplate built with Bun.js, TypeScript, DDD, and Clean Architecture. Features RBAC, Firebase Auth, Swagger docs, and 8 Claude Code AI skills for rapid development.

510Updated 2mo ago

Intermediate30min to implementautomation

Saves ~420 min per use

Quick InstallView Source

git clone https://github.com/moasadi/ddd-bun-api-boilerplate.git

Works with:

Claude

Overview

About This Skill

Hermes is a production-ready backend boilerplate demonstrating Domain-Driven Design (DDD) and Clean Architecture principles using Bun.js, TypeScript, and MongoDB. It provides a scalable foundation for building multi-tenant SaaS APIs with Firebase authentication, permission-based access control, comprehensive Swagger documentation, and built-in features like rate limiting, caching, audit trails, and health checks. The boilerplate includes two working example contexts (User and Todo management) organized as bounded domains with strict separation of concerns. Developers can use this as a reference implementation to rapidly build maintainable, production-grade REST APIs following industry best practices without reinventing architectural patterns.

How to Use

Clone the repository, install dependencies with `bun install`, configure environment variables (Firebase credentials and MongoDB URI), and run `bun run dev` to start the development server. The API will be available at http://localhost:3000/api/v1 with Swagger documentation at http://localhost:3000/swagger.

Use Cases

Rapid development of multi-tenant SaaS backends with pre-configured architecture

Learning DDD and Clean Architecture patterns through a working example

Building secure REST APIs with Firebase authentication and permission-based access control

Creating maintainable TypeScript APIs with strict typing and zero technical debt

Setup & Installation

Quick Install

No install command available. Check the GitHub repository for manual installation instructions.

Alternative Install (Git Clone)

git clone https://github.com/moasadi/ddd-bun-api-boilerplate

Requirements

Claude Code or compatible AI agent
Works with: Claude

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Generate a production-ready API endpoint for a [COMPANY] in the [INDUSTRY] sector. The endpoint should handle [DATA] and include RBAC permissions. Use the ddd-bun-api-boilerplate with Firebase Auth and provide Swagger documentation.

Example Output

```markdown
## API Endpoint: User Profile Management

### Description
Handles CRUD operations for user profiles with role-based access control (RBAC).

### Endpoint
`POST /api/users/profile`

### Request Headers
```
- `Authorization: Bearer <Firebase_ID_TOKEN>`
- `Content-Type: application/json`
```

### Request Body
```json
{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "admin"
}
```

### Response
```json
{
  "status": "success",
  "message": "User profile updated successfully",
  "data": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "role": "admin"
  }
}
```

### Swagger Documentation
```yaml
paths:
  /api/users/profile:
    post:
      summary: Update user profile
      description: Updates the user profile with the provided data.
      security:
        - firebaseAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserProfile'
      responses:
        '200':
          description: User profile updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfile'
```
```