Getting Started

Requirements

• Bun v1.0+

Create a New Project

bun create gaman@latest

This will generate a new project with the following structure:

my-app/
├── src/
│   ├── index.ts                      # Entry point & bootstrap
│   ├── router.ts                     # Route definitions
│   └── module/
│       ├── controllers/
│       │   └── AppController.ts      # Example controller
│       ├── services/
│       │   └── AppService.ts         # Example service
│       └── middlewares/
│           └── AppMiddleware.ts      # Example middleware
├── package.json
└── tsconfig.json

Manual Installation

If you want to add GamanJS to an existing project:

bun add gaman @gaman/michi

Running the Server

bun run dev

Output:

GamanJS Framework v2
A Lean Framework for Heavy-Duty Enterprise Performance.
 ──────────────────────────────────────
HTTP  : Listening at http://localhost:3431
 ──────────────────────────────────────
Orchestration complete. Ready for requests.

What’s Next

• Bootstrap — Configuration and starting the server
• Router — Defining routes
• Controller — Separating handler logic