Getting Started with Ignis
Welcome to Ignis! This guide takes you from zero to a fully functional, database-connected REST API.
Recommended learning path:
1. Prerequisites
Before starting, ensure you have the required tools installed.
2. Philosophy
Understand the "why" behind Ignis - how it combines enterprise-grade patterns with high performance.
3. Choose Your Starting Point
Option A: 5-Minute Quickstart (Recommended for First-Timers)
Build your first "Hello World" endpoint in 5 minutes. No database, minimal setup.
Option B: Complete Setup Guide
Full production setup with ESLint, Prettier, and proper project structure.
4. Building a CRUD API
Most important guide - build a complete Todo API covering:
- Models with Drizzle ORM
- DataSources & Repositories
- Controllers with auto-generated endpoints
- Dependency Injection
5. Core Concepts
Deep dive into framework internals:
- The Application Class - Lifecycle and configuration
- Dependency Injection - DI container patterns
- Controllers - Routing and request handling
- Services - Business logic layer
- Persistent Layer - Models, DataSources, Repositories
- Components - Reusable modules
6. Best Practices
Production-ready patterns and practices:
- Architectural Patterns - Layered architecture
- API Usage Examples - Real-world patterns
- Code Style Standards - ESLint & Prettier
- Security Guidelines - Protect your API
- Performance Optimization - Speed improvements
- Deployment Strategies - Go to production
- Troubleshooting Tips - Common issues
- Contribution Workflow - Contribute to Ignis