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 for building data-driven admin and ERP applications. You define your database models in Python using SQLModel, and the framework generates the REST API, the SQLAdmin back-office, and the React CRUD frontend automatically. It is designed for developers who want to ship production-ready applications without writing repetitive boilerplate — the generated code is plain Python and TypeScript that you own, read, and extend.

​
What you get

VeloIQ combines a backend stack, a frontend component library, and a CLI into a single cohesive toolkit. Backend — FastAPI · SQLModel · SQLAdmin · Alembic
  • A FastAPI application factory with CORS, JWT authentication middleware, and RBAC built in
  • Automatic CRUD router generation — list, get, create, update, and delete endpoints from a model class
  • A SQLAdmin back-office at /admin/ with zero configuration
  • Alembic migrations pre-wired and managed by veloiq db upgrade
  • Support for PostgreSQL, MySQL, SQLite, and any other SQLAlchemy-compatible database
Frontend — @veloiq/ui · Refine · Ant Design
  • @veloiq/ui, a React component library that renders schema-driven CRUD pages with no boilerplate
  • Powered by Refine for data fetching and state management, and Ant Design for the component system
  • Light and dark mode, keyboard shortcuts, and responsive layout included
CLI — veloiq commands
CommandWhat it does
veloiq new <app>Scaffold a new full-stack project
veloiq add-module <name>Add a domain module to an existing project
veloiq generateRegenerate api.py and TypeScript schemas from your models
veloiq runStart the development server
veloiq db upgradeApply Alembic migrations

​
Key features

Auto-generated CRUD API Drop a models.py in app/modules/<name>/ and the framework exposes paginated list, get, create, update, and delete endpoints — no router code to write. React CRUD frontend The @veloiq/ui library reads generated TypeScript schemas and renders complete list, show, create, and edit pages. Add a model; the sidebar entry and all views appear automatically. SQLAdmin back-office A fully-featured admin panel is mounted at /admin/ with search, sort, filter, and inline editing — with zero additional configuration. Three-layer RBAC + ReBAC Control access globally by role, per model, and per individual field. Add row-level filtering with @rebac when access depends on data ownership or tenant membership. Miller columns Hierarchical parent/child relationships render as an interactive multi-column browser, detected automatically from self-referential model relationships. Side panels Click any list row to open a detail panel beside the list. Drag the divider to resize; minimize, maximize, or pop out to a full page. Relations explorer An interactive graph on any record’s Show page visualises all connected records. Click any node to navigate directly to it. Analysis charts Distribution and summary charts appear automatically on relation tables with more than one row. Toggle per view; preferences are saved. Bulk actions Select multiple rows for bulk edit, bulk delete, or CSV export.

​
Prerequisites

Before you install VeloIQ, make sure you have:
  • Python 3.10 or later — for the framework package and CLI
  • Node.js 18 or later — for the React frontend

​
Where to go next

Quick Start

Install the CLI, scaffold a project, and have a running app in under 15 minutes.

Tutorial

Build a complete task manager step by step — models, relations, auth, and access control.

Models

Learn how TimestampedModel, FrameworkModel, and jm_relationship work.

Access control

Understand the three-layer RBAC and row-level ReBAC system.
VeloIQ uses an open-core model. The framework core is released under the MIT License and is free to use. Pro and Enterprise tiers add a WYSIWYG page builder, the VeloIQ AI query engine, User Journeys, Advanced ReBAC, SSO, compliance audit logs, and Goal-Seeking Scenarios. See open-core for the full comparison.