Skip to main content

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 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.

Quick Start

Scaffold a new project and have a working full-stack app running in minutes.

Tutorial

Build a complete task manager step-by-step — API, frontend, auth, and access control.

Core Concepts

Learn about models, modules, and the three-layer access control system.

CLI Reference

Every VeloIQ command — scaffold, generate, run, migrate, and search.

​
What VeloIQ gives you

Write a Python model class. The framework handles everything else. 
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
1

Install the CLI

pip install veloiq-framework
2

Scaffold your project

veloiq new my-app
cd my-app
3

Define your models and generate

Write your models in backend/app/modules/, then run veloiq generate to create the API and frontend schemas.
4

Start the app

veloiq run          # backend at http://localhost:8000
npm run dev         # frontend at http://localhost:5173

​
Key capabilities

Auto-generated REST API

Full CRUD endpoints are generated from your SQLModel definitions — no router code to write.

React CRUD Frontend

The @veloiq/ui component library renders schema-driven list, show, create, and edit pages.

Three-layer RBAC

Control access globally by role, per model, and per field — with row-level ReBAC support.

Miller Column Tree Views

Hierarchical data renders as interactive multi-column browsers — detected automatically.

SQLAdmin Back-Office

A fully-featured admin panel at /admin/ with search, sort, and filter — zero config.

Pro & Enterprise Tier

WYSIWYG page builder, AI query engine, SSO, audit logs, and goal-seeking scenarios.