Skip to content

GamanJS/gaman

Repository files navigation

A Lean Framework for Enterprise Scalability.
"Complexity doesn't have to be heavy.
Built on Bun, designed for Logic, optimized for Scale."

Disocrd npm version npm download Commit Activity Commit Activity npm license github stars


The Lean Manifesto

  • Zero Magic: All data flows are transparent (Logic-first).
  • Native Speed: Maximizing Bun & Gaman Wire.
  • Opt-in Complexity Go enterprise scale only when you need it.

Create a New Project

GamanJS currently only supports Bun runtime.

bun create gaman@latest

GamanJS Project Structure 🏗️

GamanJS embraces the Feature-Based Modularity philosophy. This structure is designed to keep applications clean, easy to test, and scalable as your business expands.

Enterprise Project Architecture

In a production scale or Enterprise project, the GamanJS folder structure will look like this:

src/
├── index.ts                 # The Orchestrator (Entry Point)
├── database/               # Database Configuration
└── modules/                 # Powerhouse of your Application
    ├── app/                 # Infrastructure Module (Global/Shared)
    │   ├── controllers/     # Handlers for Global Requests (Health, Index)
    │   │   └── AppController.ts
    │   ├── services/        # Shared Utilities & System Services
    │   │   └── AppService.ts
    │   └── AppRouter.ts     # Global Middleware & Base Routing
    │
    └── user/                # Feature Module (Example: User Management)
        ├── controllers/     # Request Handlers (Login, Register, Profile)
        │   └── UserController.ts
        ├── services/        # Business Logic (Auth Logic, User CRUD)
        │   └── UserService.ts
        ├── models/          # Data Access Layer (Powered by @gaman/orm)
        │   └── UserModel.ts
        └── UserRouter.ts    # Scoped Routes & Feature Middleware

Documentation

visit our https://gamanjs.github.io/

Star History

Star History Chart

All contributors ✨

A table of avatars from the project's contributors

Contributing

New Contributing welcome! Check out our Contributing Guide for help getting started.

Links

Sponsor this project

  •  
  •  

Contributors

Languages