Gati Framework

Appearance

πŸ“š Gati Documentation ​

Welcome to the official Gati framework documentation!

Gati is a next-generation TypeScript/Node.js framework for building cloud-native, versioned APIs with automatic scaling, deployment, and SDK generation.

For New Users ​

For Developers ​

For Deployment ​

API Reference ​

Examples ​

Architecture & Design ​

Changelog & Updates ​

Contributing ​

πŸ“¦ Package Versions ​

PackageVersionStatus
@gati-framework/core0.4.1βœ… Published
@gati-framework/runtime2.0.0βœ… Published
@gati-framework/cli1.0.0βœ… Published
gatic0.1.0βœ… Published

🎯 Documentation Structure ​

docs/
β”œβ”€β”€ README.md                    # This file
β”œβ”€β”€ onboarding/                  # Getting started guides
β”‚   β”œβ”€β”€ what-is-gati.md
β”‚   β”œβ”€β”€ quick-start.md
β”‚   └── getting-started.md
β”œβ”€β”€ guides/                      # Developer guides
β”‚   β”œβ”€β”€ handlers.md
β”‚   β”œβ”€β”€ modules.md
β”‚   β”œβ”€β”€ middleware.md
β”‚   β”œβ”€β”€ context.md
β”‚   β”œβ”€β”€ error-handling.md
β”‚   β”œβ”€β”€ deployment.md
β”‚   β”œβ”€β”€ kubernetes.md
β”‚   └── typescript-config.md
β”œβ”€β”€ api-reference/               # API documentation
β”‚   β”œβ”€β”€ handler.md
β”‚   β”œβ”€β”€ request.md
β”‚   β”œβ”€β”€ response.md
β”‚   └── context.md
β”œβ”€β”€ examples/                    # Code examples
β”‚   └── hello-world.md
β”œβ”€β”€ architecture/                # Design documents
β”‚   β”œβ”€β”€ overview.md
β”‚   β”œβ”€β”€ design-decisions.md
β”‚   β”œβ”€β”€ milestones.md
β”‚   β”œβ”€β”€ roadmap.md
β”‚   └── mvp-roadmap.md
β”œβ”€β”€ changelog/                   # Version history
β”‚   β”œβ”€β”€ current-state.md
β”‚   β”œβ”€β”€ mvp-completion.md
β”‚   β”œβ”€β”€ documentation-summary.md
β”‚   └── task-completion-summary.md
└── contributing/                # Contribution guides
    β”œβ”€β”€ README.md
    β”œβ”€β”€ agentic-development.md
    β”œβ”€β”€ release-guide.md
    └── codebase-structure.md

πŸ” Finding What You Need ​

I want to... ​

Create my first Gati app ​

β†’ Start with Quick Start

Understand Gati's architecture ​

β†’ Read What is Gati? and Architecture Overview

Write API handlers ​

β†’ Follow the Handlers Guide

Deploy to production ​

β†’ Check the Deployment Guide

Contribute to Gati ​

β†’ See Contributing Guide

Use the CLI ​

β†’ Reference GatiC CLI

Look up API details ​

β†’ Browse API Reference

πŸ’‘ Core Concepts ​

Handlers ​

Functions that process HTTP requests with signature handler(req, res, gctx, lctx).

Modules ​

Reusable business logic loaded with dependency injection.

Context ​

  • Global (gctx): Shared resources across requests
  • Local (lctx): Request-scoped data

Versioning ​

Timestamp-based routing for backward compatibility (coming in M3).

Cloud-Native ​

Kubernetes deployment with multi-cloud support.

🌟 Features ​

  • βœ… Business-logic only - Framework handles infrastructure
  • βœ… Cloud-pluggable - AWS, GCP, Azure support
  • βœ… Type-safe - Full TypeScript support
  • βœ… Auto-scaling - Kubernetes-native
  • ⏳ Versioned APIs - Coming in M3
  • ⏳ SDK Generation - Coming in M5
  • ⏳ Control Panel - Coming in M4

πŸ“– Learning Path ​

Beginner ​

  1. What is Gati?
  2. Quick Start
  3. Hello World Example
  4. Handlers Guide

Intermediate ​

  1. Getting Started Guide
  2. Modules Guide
  3. Middleware Guide
  4. Context Guide
  5. Error Handling

Advanced ​

  1. Deployment Guide
  2. Kubernetes Guide
  3. Architecture Overview
  4. Design Decisions

Contributor ​

  1. Contributing Guide
  2. Codebase Structure
  3. Agentic Development
  4. Release Guide

πŸ†˜ Getting Help ​

🀝 Contributing to Docs ​

Found an error or want to improve the documentation?

  1. Fork the repository
  2. Edit the relevant markdown file
  3. Submit a pull request

See Contributing Guide for details.

οΏ½ Development ​

This documentation website is built with VitePress.

bash
# Install dependencies
cd docs && npm install

# Start dev server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Last Updated: November 12, 2025
Maintained By: Krishna Paul (@krishnapaul242)

"Gati is not just fastβ€”it's forward." ⚑

Released under the MIT License.

Copyright Β© 2025 Krishna Paul