Documentation

Welcome to the Yama JS documentation. Learn how to build powerful APIs with YAML-first configuration.

Getting Started

New to Yama? Start here:

• Installation & Setup - Get Yama installed and create your first project
• Quick Start Guide - Build your first API in minutes

Core Concepts

Understand the fundamentals:

• Schemas - Define your data structure
• Entities - Database tables with automatic CRUD
• Endpoints - API routes and handlers
• Handlers - Business logic in TypeScript

Guides

Step-by-step guides for common tasks:

• Creating Handlers - Write custom business logic
• Custom Endpoints - Advanced endpoint patterns
• Database Migrations - Manage schema changes
• Authentication - Set up auth and authorization
• Environment Variables - Configuration management

API Reference

Complete reference documentation:

• CLI Commands - All available CLI commands
• Configuration Reference - Complete yama.yaml reference

Examples

See Yama in action:

• Todo API Example - Complete CRUD API example

Deployment

Deploy your Yama applications:

• Vercel - Serverless deployment
• Docker - Container deployment
• AWS Lambda - Lambda functions

Need Help?

• GitHub Discussions  - Ask questions
• GitHub Issues  - Report bugs
• GitHub Repository  - View source code