Skip to content

README.en.md

Latest commit

 

History

History
246 lines (181 loc) · 11.7 KB

README.en.md

File metadata and controls

246 lines (181 loc) · 11.7 KB
Raw

logo

FastApiAdmin v3.0.0

🚀 One codebase for Web, H5 and Mini Program — AI code generation + RBAC + Docker, ready to ship

An enterprise full-stack foundation built on FastAPI + Vue3 + TypeScript: shared types, complete permissions, one source for all surfaces.

GitHub Stars GitHub Forks Gitee Stars Gitee Forks AtomGit G-Star
License Commit Activity

English | 简体中文

🖥️ Screenshots

Web

Dashboard

Mobile (H5 / Mini Program / App from one codebase)

Login with puzzle verification Mobile workbench Profile

All surfaces share one brand token set: logo, primary colors, radii, spacing, dark-mode layers, and destructive-action semantics.

💡 Why FastapiAdmin?

You Need FastapiAdmin Django Admin Frontend-Only
🎯 Ready-to-use admin system ✅ ⚠️ Limited ❌ UI only
⚡ FastAPI async high-performance backend ✅ ❌ Sync-first ❌ No backend
🔐 RBAC menu/button/data level permissions ✅ ❌ Basic ❌
🤖 Code generator (table → full CRUD) ✅ ❌ ❌
📱 Mobile (H5 + Mini Program) included ✅ ❌ ❌
🐳 Docker one-click deploy (Nginx + SSL) ✅ ❌ ❌

👉 Full comparison: Why FastapiAdmin?

✅ A good fit for

  • Teams that need a usable enterprise admin / operations system in 1–4 weeks;
  • Projects that want shared frontend/backend types and less API glue;
  • Products that must cover Web admin + mobile / mini program with one domain model;
  • Teams that need code generation, RBAC, audit logs and scheduled jobs as a foundation.

⚠️ Not a good fit for

  • Full IM requirements (files, recall, read receipts, multi-device sync);
  • Real-time chat / scheduling that must horizontally scale from day one (currently single-instance by design).

🍪 Live Demo

URL Account
💻 Web service.fastapiadmin.com/web admin / 123456
📱 Mobile service.fastapiadmin.com/app admin / 123456
📖 Official Docs service.fastapiadmin.com No login

🚀 5–15 Minute Quick Start

# 1. Clone
git clone https://github.com/fastapiadmin/FastapiAdmin.git

# 2. Configure environments
cp backend/env/.env.example backend/env/.env.dev
cp frontend/web/.env.development.example frontend/web/.env.development

# 3. Start backend (auto-creates tables + seed data on first run)
cd backend && uv sync && uv run main.py run --env=dev

# 4. Start frontend
cd ../frontend/web && pnpm install && pnpm run dev

# ✅ Open http://127.0.0.1:5173, login with admin/123456

First launch creates tables and demo data automatically. Backend defaults to 8001, frontend to 5173. Use Alembic migrations and dedicated secrets in production.

Requirements
Python ≥ 3.12 Node.js ≥ 20 + pnpm
MySQL 8.0+ / PostgreSQL 14+ Redis 6.x / 7.x

🐳 Or: One-Command Docker Deployment

cp docker/.env.example docker/.env    # Fill in MySQL / Redis passwords
./deploy.sh                           # Build images and start the full stack (Nginx + SSL included)

For ports, SSL certificates and frontend builds, see the Docker deployment guide.

📦 Structure

FastapiAdmin/            # Monorepo full-stack project
├─ backend/              # FastAPI backend (Pydantic 2.0 + SQLAlchemy + Alembic)
├─ frontend/
│   ├── web/             # Vue3 Web (Element Plus + TypeScript)
│   ├── app/             # UniApp Mobile (H5 + Mini Program + App)
│   └── docs/            # VitePress documentation
├─ docker/               # Docker Compose deploy (Nginx + SSL)
├─ deploy.sh             # One-click deploy script
└─ LICENSE               # MIT

🧱 Tech Stack

Layer Technology
Backend FastAPI · Pydantic 2 · SQLAlchemy 2 · Alembic · Redis
Web Vue 3 · TypeScript · Vite · Element Plus · Pinia · Tailwind
Mobile UniApp · Vue 3 · Wot Design Uni
AI Agno · pluggable model providers
Deploy Docker Compose · Nginx · SSL

📌 Built-in Features

200+ REST endpoints · MySQL / PostgreSQL / SQLite · SFTP / S3 / OSS / COS / OBS storage adapters · Trim modules with a single ENABLED_MODULES entry

Core Modules (always enabled, cannot be removed)

Module Capabilities
📊 Dashboard Workbench, Analytics
⚙️ System Management Users, Roles, Menus, Departments, Positions, Dicts, Config, Notices, Tickets, Versions
👀 Monitoring Online users, Server monitoring, Cache monitoring
📝 Logs Operation audit
🧰 Dev Tools API Docs

Extension Modules (enabled by default, trim via ENABLED_MODULES)

Module Capabilities Toggle
🧩 Task Management Scheduled tasks + visual workflow orchestration (built-in business nodes) task
🔧 Code Generator Table → full frontend/backend code generator
📁 Storage Unified file / object storage (SFTP / S3 / OSS / COS / OBS) storage
🤖 AI Chat Agno-powered agent conversations ai
💬 Internal Chat Text-only private / group chat between users (WebSocket real-time push + unread badge) chat

🔧 Module Toggling

Extension modules can be enabled/disabled on demand via ENABLED_MODULES in backend/app/config/setting.py — just remove an item from the list; no code or menu deletion needed. The corresponding REST endpoints, WebSocket endpoints and initialization logic will not be loaded automatically:

# e.g. Disable internal chat and AI assistant, keep the rest
ENABLED_MODULES = ["generator", "task", "storage"]

🚦 Deployment Notes

  • Chat scope: Internal chat is positioned as lightweight internal communication — text-only messages. No file transfer, recall, read receipts, or multi-device sync (IM features). For strong IM needs, integrate mature products such as WeCom / DingTalk / Feishu. It can be disabled anytime by removing chat from ENABLED_MODULES.
  • Single-instance deployment: Real-time features (internal chat WebSocket, scheduled task scheduler) rely on in-memory connections and local scheduling within a single instance — please deploy as a single instance. For horizontal scaling, integrate Redis Pub/Sub or a message queue yourself.
  • Key security: Configure all third-party keys (AI, cloud storage, etc.) in the backend/env/.env.* environment variables. Never commit them to the repository or store them in the database.
  • Database migrations: Manage schema changes with Alembic migrations in production (uv run alembic upgrade head); create_all is only a fallback for first-time initialization.

📷 More Screenshots

Login + puzzle verification Code Generator AI Assistant
Login Code Generator AI

Screenshots come from the current release: light theme, real API data and the latest brand visuals.

❓ FAQ

Q: Login says the captcha is invalid?
A: Make sure Redis is running, then complete the puzzle verification. The development credentials are admin / 123456.

Q: Can I use only the Web app?
A: Yes. frontend/web runs independently; the mobile project is optional.

Q: How do I trim modules?
A: Edit ENABLED_MODULES in backend/app/config/setting.py; endpoints and initialization are unloaded automatically.

Q: How should production initialize the database?
A: Run uv run alembic upgrade head; do not rely on create_all.

📖 Documentation

🤝 Contributing

Issues and PRs are welcome! See Contributing Guide.

👥 Community

⭐ Star History

Star History Chart

👥 Contributors

Thank you to all contributors who have contributed code to FastapiAdmin.

🙏 Acknowledgments

If you find this project useful, please give it a ⭐️ Star!