📍 Documentation Sitemap
Navigate through all Baasix documentation with this interactive guide. Click any link to jump directly to that page.
🚀 Getting Started
| Page | Description |
|---|---|
| Introduction | Overview of Baasix and getting started |
| CLI Guide | Command line interface setup and usage |
| SDK Guide | Client SDK for JavaScript/TypeScript |
🔐 Authentication & Security
| Page | Description |
|---|---|
| Authentication Routes | Login, register, password reset, and session management |
| SSO Authentication | Single Sign-On with Google, GitHub, and other providers |
| Session Limits | Control concurrent sessions per user |
| Permission Routes | Role-based access control (RBAC) |
| Multi-tenant Guide | Build multi-tenant SaaS applications |
📦 Core API Routes
| Page | Description |
|---|---|
| Item Routes | CRUD operations for your data |
| Schema Routes | Create and manage database schemas |
| File Routes | File upload, storage, and management |
| Settings Routes | Application configuration |
| Notification Routes | Push notifications and alerts |
| Reports Routes | Generate reports and analytics |
| Utils Routes | Utility endpoints |
| API Routes Reference | Complete API reference |
🔍 Query & Filtering
| Page | Description |
|---|---|
| Advanced Query Guide | Complex queries with relations |
| Complete Filter Reference | All 50+ filter operators explained |
| Item Query Reference | Pagination, sorting, and field selection |
🗄️ Schema & Database
| Page | Description |
|---|---|
| Schema Reference | Field types, relationships, and indexes |
| Database Schema Guide | Design patterns and best practices |
| Virtual Fields | Computed fields and aggregations |
| Migrations Guide | Database migrations and versioning |
⚡ Hooks & Extensions
| Page | Description |
|---|---|
| Hooks System | Lifecycle hooks for data operations |
| Hooks & Endpoints Guide | Creating custom endpoints |
| Extensions | Build and install plugins |
🔄 Workflows
| Page | Description |
|---|---|
| Workflow Routes | Workflow automation API |
| Custom Modules | Build custom workflow actions |
| Export/Import Workflows | Share workflows between projects |
🛠️ Integration & Deployment
| Page | Description |
|---|---|
| Integration Guide | Connect Baasix with your frontend |
| Deployment Guide | Deploy to production |
| Socket.IO Integration | Real-time updates |
| Error Handling | Handle errors gracefully |
🤖 AI & Advanced Features
| Page | Description |
|---|---|
| MCP Server | Model Context Protocol for AI agents |
| Tasks Service | Background jobs and scheduled tasks |
| Additional Features | Soft deletes, caching, and more |
📚 Reference
| Page | Description |
|---|---|
| Services Reference | Internal services API |
| Utilities Reference | Helper functions and utilities |
📖 Quick Reference by Use Case
"I want to..."
| Goal | Start Here |
|---|---|
| Set up a new project | CLI Guide → Integration Guide |
| Add user authentication | Authentication Routes → SSO Guide |
| Create a database schema | Schema Routes → Schema Reference |
| Query data with filters | Item Routes → Filter Reference |
| Add custom business logic | Hooks System → Hooks Guide |
| Build a multi-tenant app | Multi-tenant Guide → Permission Routes |
| Deploy to production | Deployment Guide → Settings Routes |
| Add real-time updates | Socket.IO Integration |
| Use AI with Baasix | MCP Server |
| Schedule background jobs | Tasks Service |
💡 Tip: Use Ctrl/Cmd + K to search across all documentation pages.