# fastapi-react-admin > Open-source admin foundation on FastAPI + React 19 + shadcn/ui — web, desktop and mobile in one monorepo, row-level data permissions, multi-tab that keeps state, approval workflow, a permission-bound AI assistant; PostgreSQL, SQL Server or MySQL. Every page has a Markdown source: replace the trailing `/` of its URL with `.md`. All pages in one file: https://yile2020.github.io/fastapi-react-admin/en/llms-full.txt - Source code: https://github.com/yile2020/fastapi-react-admin - Conventions for coding agents live in the repository itself: `CLAUDE.md` at the root and an `AGENTS.md` in each module directory - 中文: https://yile2020.github.io/fastapi-react-admin/llms.txt ## Getting started - [What is fastapi-react-admin?](https://yile2020.github.io/fastapi-react-admin/en/getting-started/introduction.md): An open-source admin foundation on FastAPI + React 19 + shadcn/ui — web, desktop and mobile in one monorepo, built for writing code with AI; why it exists and how it differs from a typical admin template. - [Quick start](https://yile2020.github.io/fastapi-react-admin/en/getting-started/quick-start.md): Start PostgreSQL and Redis in Docker, install dependencies, initialize a development database and sign in locally. Each step includes a check. ## Features - [Feature overview](https://yile2020.github.io/fastapi-react-admin/en/features/overview.md): Everything fastapi-react-admin ships with, by area — access control and data scopes, sign-in security, import/export, approvals, AI assistant, open API, files, messaging, operations and clients; which menu each lives in, which plugin provides it, and how much the mobile app covers. - [Sign-in and security](https://yile2020.github.io/fastapi-react-admin/en/features/login-security.md): Choose a sign-in method, enable two-factor authentication and manage password rules. Session management and configuration have their own guides. - [Session management](https://yile2020.github.io/fastapi-react-admin/en/features/login-sessions.md): View active devices, force a session to sign out, and set idle timeouts and per-client limits. - [Users, roles, departments and menus](https://yile2020.github.io/fastapi-react-admin/en/features/rbac.md): How to use the four permission screens: enabling users, resetting passwords and the "admin sign-in" flag, the role permission matrix, department tree rules, the five menu types (directory / menu / button / embedded page / external link) and dead-link checks, and when permission changes take effect. - [Data permissions (RBAC + row-level data scopes)](https://yile2020.github.io/fastapi-react-admin/en/features/data-permissions.md): RBAC for menus, buttons and endpoints, plus row-level data scopes — each role's rules compile into one SQL WHERE condition applied in the DAO layer. - [Logs and audit](https://yile2020.github.io/fastapi-react-admin/en/features/audit-logs.md): Sign-in log (including lockouts and forced sign-outs), operation log (redacted automatically), and data change history: who changed which field from what to what, when and from where, linked to the operation log. A signed tamper-evident chain, and 180-day retention by default to meet the six-month minimum in China's Cybersecurity Law. - [Dashboard and workspace](https://yile2020.github.io/fastapi-react-admin/en/features/workspace.md): A personal dashboard (choose cards, drag to reorder, set widths, cards appear by permission, layout stored on the server and synced across devices); the ⌘K command palette, shortcuts and product tour; accent color, radius, density and tab style; list columns shown and ordered via the URL; per-user time zone, Chinese and English, and a new-version prompt. - [Multi-tab that keeps state](https://yile2020.github.io/fastapi-react-admin/en/features/multi-tab.md): Open tabs stay mounted under React 19.2's , so half-filled forms and expanded trees survive switching; filters and paging live in the URL. - [Approval workflow](https://yile2020.github.io/fastapi-react-admin/en/features/approval-workflow.md): A Feishu-style approval engine for FastAPI + React — form designer, flow tree with conditional branches, or-sign / co-sign, send back, add approvers, timeouts. - [Notifications and notices](https://yile2020.github.io/fastapi-react-admin/en/features/notifications.md): Real-time in-app inbox, notices with rich text, attachments and audiences, and routing to email, SMS and Feishu / DingTalk / WeCom group bots. - [Import and export](https://yile2020.github.io/fastapi-react-admin/en/features/import-export.md): Server-side xlsx / csv export from list pages (current filter or selected rows, over 5,000 rows runs in the background and notifies you, formula-injection safe); generic import for users, departments and dictionary items with dropdown templates, preview before commit, three modes, an error report, and a whole department tree from one file. - [Files and storage](https://yile2020.github.io/fastapi-react-admin/en/features/file-storage.md): File manager with previews on local disk or S3-compatible storage (Apache OpenDAL), instant upload by hash, parallel chunks and resume after refresh. - [AI assistant](https://yile2020.github.io/fastapi-react-admin/en/features/ai-assistant.md): A chat assistant whose tool calls run as the signed-in user, with the same permissions and data scope, confirmed writes and every call audited. - [Desktop and mobile clients](https://yile2020.github.io/fastapi-react-admin/en/features/clients.md): An Electron desktop app with Windows, macOS and Linux installers, auto-update and silent printing, plus a native Expo / React Native mobile app. ## Development - [Architecture and project structure](https://yile2020.github.io/fastapi-react-admin/en/guides/project-structure.md): How the front end and back end are layered and which files one request passes through, using the user list as the example — plus where to look when you want to change a form, a list, API fields, permission codes or a table. - [Add a business module from scratch](https://yile2020.github.io/fastapi-react-admin/en/guides/first-module.md): Build a real Customers module end to end, from model and migration through the three backend layers, menus and permissions, to a list page with data scopes. - [Developer tools](https://yile2020.github.io/fastapi-react-admin/en/features/developer-tools.md): A component sandbox (49 demos, live knobs, code that lists only non-default props), a colour palette, playgrounds for the filter bar and the data table; the packages/ui component library has no dependency on other packages and can be moved wholesale into another project; the frontend / backend contract is generated offline from the backend's OpenAPI. - [Plugins](https://yile2020.github.io/fastapi-react-admin/en/features/plugins.md): Backend plugins follow the upstream FBA design: one directory and one plugin.toml declaring routes, settings, dependencies and supported databases. What the 10 built-in plugins are, how fba add installs one, what enabling and disabling on the Plugins page does, and which extension points a plugin can hook into (notification kinds, data change history, import / export, webhook events, SMS templates, AI tools). - [Open API (AK/SK signed)](https://yile2020.github.io/fastapi-react-admin/en/features/open-api.md): Read-only /api/open/v1 endpoints signed with AK/SK and HMAC-SHA256, with scopes, IP allow-lists, replay protection, rate limits, call logs and webhooks. ## Operations - [Deploying to a server](https://yile2020.github.io/fastapi-react-admin/en/getting-started/deployment.md): Deploy fastapi-react-admin with Docker Compose from images CI pushes to GHCR — three files on the server, migrations before start, one health URL, rollback by commit tag. - [Databases: PostgreSQL, SQL Server, MySQL](https://yile2020.github.io/fastapi-react-admin/en/features/databases.md): One FastAPI codebase and one Alembic migration chain for PostgreSQL (default), SQL Server and MySQL. Switch with DATABASE_TYPE; CI runs the full suite on two. - [Config and data dictionary](https://yile2020.github.io/fastapi-react-admin/en/features/config-dict.md): Config lets admins change part of the runtime configuration in the UI (sign-in policy, passwords and lockout, sessions, email, notifications, webhooks, file uploads, log retention), overriding .env without a restart and validated on write; the data dictionary keeps "type → options" tables, cached and importable / exportable. - [Security configuration](https://yile2020.github.io/fastapi-react-admin/en/reference/security-config.md): Sign-in, password and session setting keys, defaults and precedence, with extension notes and source references. - [Scheduled jobs](https://yile2020.github.io/fastapi-react-admin/en/features/scheduler.md): Manage Celery scheduled jobs in the UI: cron or fixed interval, a cron preview, enable / disable, run now, run history; changes need no beat restart. What each of the 11 built-in jobs does (log cleanup, recycle bin, expired exports, notification and webhook delivery, approval timeouts, heartbeat). - [Monitoring and health checks](https://yile2020.github.io/fastapi-react-admin/en/features/monitoring.md): Server monitoring (CPU, memory, disks, the process) and Redis monitoring (memory, keys, ops/s, command stats) show the present only and store no history; one unauthenticated health-check URL reports the API, database, Redis, scheduler and worker, 200 when all are fine and 503 otherwise. - [Upgrading](https://yile2020.github.io/fastapi-react-admin/en/reference/upgrade.md): How to upgrade — image deployments pull new images and migrations run automatically; forks merge the upstream tag and run migrations. With compatibility promises and a checklist. ## FAQ - [FAQ and troubleshooting](https://yile2020.github.io/fastapi-react-admin/en/reference/faq.md): Troubleshooting indexed by the exact error text — 25 common problems with local setup, sign-in, database migrations, frontend work and production deploys.