> ## Documentation Index
> Fetch the complete documentation index at: https://docs.veloiq.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# VeloIQ: Full-Stack Framework for Data-Driven Apps

> VeloIQ generates a REST API, SQLAdmin back-office, and React CRUD frontend from your Python models. Build production-ready admin and ERP apps fast.

VeloIQ is an open-core full-stack framework that turns Python SQLModel definitions into complete, production-ready applications. Define your data models once and the framework generates your REST API, back-office admin panel, and React frontend automatically — leaving you to focus on the business logic that makes your application unique.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Scaffold a new project and have a working full-stack app running in minutes.
  </Card>

  <Card title="Tutorial" icon="graduation-cap" href="/tutorial">
    Build a complete task manager step-by-step — API, frontend, auth, and access control.
  </Card>

  <Card title="Core Concepts" icon="book" href="/concepts/models">
    Learn about models, modules, and the three-layer access control system.
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/reference/cli-overview">
    Every VeloIQ command — scaffold, generate, run, migrate, and search.
  </Card>
</CardGroup>

## What VeloIQ gives you

Write a Python model class. The framework handles everything else.

```python theme={null}
from veloiq_framework import TimestampedModel, jm_relationship
from typing import List, Optional
from sqlmodel import Field

class Project(TimestampedModel, table=True):
    __tablename__ = "project"
    name: str
    status: str = "active"
    owner_id: Optional[int] = Field(default=None, foreign_key="team_member.id")
    tasks: List["Task"] = jm_relationship(back_populates="project")
```

From this single file, VeloIQ generates:

* A paginated REST API with list, get, create, update, and delete endpoints
* A SQLAdmin back-office at `/admin/`
* A React CRUD frontend with sorting, filtering, and bulk actions

<Steps>
  <Step title="Install the CLI">
    ```bash theme={null}
    pip install veloiq-framework
    ```
  </Step>

  <Step title="Scaffold your project">
    ```bash theme={null}
    veloiq new my-app
    cd my-app
    ```
  </Step>

  <Step title="Define your models and generate">
    Write your models in `backend/app/modules/`, then run `veloiq generate` to create the API and frontend schemas.
  </Step>

  <Step title="Start the app">
    ```bash theme={null}
    veloiq run          # backend at http://localhost:8000
    npm run dev         # frontend at http://localhost:5173
    ```
  </Step>
</Steps>

## Key capabilities

<CardGroup cols={2}>
  <Card title="Auto-generated REST API" icon="code" href="/concepts/modules">
    Full CRUD endpoints are generated from your SQLModel definitions — no router code to write.
  </Card>

  <Card title="React CRUD Frontend" icon="display" href="/reference/ui-overview">
    The `@veloiq/ui` component library renders schema-driven list, show, create, and edit pages.
  </Card>

  <Card title="Three-layer RBAC" icon="shield-halved" href="/concepts/access-control">
    Control access globally by role, per model, and per field — with row-level ReBAC support.
  </Card>

  <Card title="Miller Column Tree Views" icon="sitemap" href="/guides/ui-features">
    Hierarchical data renders as interactive multi-column browsers — detected automatically.
  </Card>

  <Card title="SQLAdmin Back-Office" icon="table-columns" href="/concepts/modules">
    A fully-featured admin panel at `/admin/` with search, sort, and filter — zero config.
  </Card>

  <Card title="Pro & Enterprise Tier" icon="star" href="/open-core">
    WYSIWYG page builder, AI query engine, SSO, audit logs, and goal-seeking scenarios.
  </Card>
</CardGroup>