# Veloiq

## Docs

- [VeloIQ Access Control: RBAC and ReBAC Guide](https://docs.veloiq.dev/concepts/access-control.md): VeloIQ provides three-layer role-based access control (RBAC) and row-level relationship-based access control (ReBAC) for fine-grained permissions.
- [Defining Data Models in VeloIQ with SQLModel](https://docs.veloiq.dev/concepts/models.md): Learn how to define VeloIQ data models using FrameworkModel, TimestampedModel, and StandardModel base classes with relationships and field options.
- [VeloIQ Modules: Auto-Loaded Domain Packages](https://docs.veloiq.dev/concepts/modules.md): VeloIQ modules are self-contained Python packages that the framework discovers and registers automatically — no manual wiring in main.py.
- [Extend VeloIQ Modules with Custom API Endpoints](https://docs.veloiq.dev/guides/custom-endpoints.md): Extend auto-generated CRUD with custom FastAPI endpoints using custom_api.py — no changes to main.py or the generated api.py required.
- [Manage Database Migrations in VeloIQ with Alembic](https://docs.veloiq.dev/guides/database-migrations.md): Manage schema changes safely in VeloIQ using Alembic migrations via the veloiq db command — create revisions, apply upgrades, and track history.
- [Configure Global Search in Your VeloIQ App](https://docs.veloiq.dev/guides/global-search.md): Wire up VeloIQ's header search bar to query your application data by registering models and fields with the veloiq search commands.
- [Built-in UI Features: VeloIQ Frontend Guide](https://docs.veloiq.dev/guides/ui-features.md): Explore VeloIQ's built-in UI features: side panels, Miller columns tree view, relations explorer, analysis charts, bulk actions, and more.
- [VeloIQ Framework: Build Full-Stack Apps Faster](https://docs.veloiq.dev/introduction.md): VeloIQ is an open-core framework that generates REST APIs, admin back-offices, and React frontends from Python SQLModel definitions.
- [VeloIQ Pricing: Free MIT Tier vs Pro Features](https://docs.veloiq.dev/open-core.md): VeloIQ's open-core model includes a fully functional MIT-licensed free tier. Pro adds WYSIWYG editing, AI query, SSO, audit logs, and more.
- [Get started with VeloIQ in under 15 minutes](https://docs.veloiq.dev/quickstart.md): Install the VeloIQ CLI, scaffold a project, define your first model, generate the API and frontend, and launch your app in minutes.
- [veloiq db: Alembic Database Migration Commands](https://docs.veloiq.dev/reference/cli-db.md): The veloiq db command wraps Alembic to create revisions, apply upgrades, and inspect migration history for your VeloIQ application.
- [veloiq generate: Generate API and Frontend Schemas](https://docs.veloiq.dev/reference/cli-generate.md): The veloiq generate command reads your SQLModel definitions and writes api.py CRUD endpoints and TypeScript schemas for the React frontend.
- [veloiq new: Scaffold a Full-Stack VeloIQ Project](https://docs.veloiq.dev/reference/cli-new.md): The veloiq new command scaffolds a complete full-stack project with backend, frontend, environment config, and code generation entry point.
- [VeloIQ CLI Reference: All Commands at a Glance](https://docs.veloiq.dev/reference/cli-overview.md): Complete reference for the veloiq CLI — scaffold projects, generate code, run the dev server, manage migrations, and configure search.
- [veloiq search: Register Models for Global Search](https://docs.veloiq.dev/reference/cli-search.md): The veloiq search command registers models and fields for VeloIQ's header search bar — writes config/search.json read by the backend.
- [VeloIQConfig: Complete Framework Configuration Reference](https://docs.veloiq.dev/reference/configuration.md): Every VeloIQConfig field and corresponding environment variable for configuring database, auth, CORS, admin panel, and modules directory.
- [VeloIQ Auto-Generated CRUD REST API Reference](https://docs.veloiq.dev/reference/crud-router.md): VeloIQ's create_crud_router generates paginated list, get, create, update, and delete endpoints automatically from your SQLModel model.
- [VeloIQ Python API: All Public Framework Exports](https://docs.veloiq.dev/reference/python-api.md): Complete reference for veloiq_framework public exports — app factory, base models, relationships, access control decorators, and utilities.
- [DynamicResource: Schema-Driven React CRUD Pages](https://docs.veloiq.dev/reference/ui-dynamic-resource.md): DynamicList, DynamicShow, DynamicCreate, and DynamicEdit render full CRUD pages from a ModelDef schema — no component code required.
- [@veloiq/ui: React Component Library for VeloIQ](https://docs.veloiq.dev/reference/ui-overview.md): The @veloiq/ui package provides schema-driven CRUD pages, layout components, auth providers, and UI utilities for VeloIQ React frontends.
- [VeloIQ React Auth and Data Providers Reference](https://docs.veloiq.dev/reference/ui-providers.md): authProvider, accessControlProvider, and httpClient wire up JWT authentication, role-based access, and HTTP requests in your React frontend.
- [VeloIQ Tutorial: Build a Full Task Manager App](https://docs.veloiq.dev/tutorial.md): Step-by-step tutorial covering models, relations, custom endpoints, RBAC, ReBAC, tree views, and built-in UI features using VeloIQ.