public/FastapiAdmin
1
0
Fork 0
mirror of https://github.com/fastapiadmin/FastapiAdmin.git synced 2026-09-21 20:55:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6bd7772e502da05e5fa4d7b59755af40fdf29f4f
FastapiAdmin/README.en.md
T
zhangtao 6bd7772e50 docs: 更新微信群二维码图片 
- 在 README.en.md 和 README.md 中更新了微信群二维码图片链接
- 将微信.png 替换为 更群.jpg，以提供更准确的微信群二维码图片
2025-03-31 17:56:20 +08:00

257 lines
9.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<div align="center">
<p align="center">
<img src="./mkdocs/docs/resources/images/logo.png" height="150" alt="logo"/>
</p>
<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">Fastapi-Vue3-Admin v1.0.0</h1>
<h4 align="center">A rapid development framework for front-end and back-end separation based on Fastapi-Vue3-Admin</h4>
<p align="center">
<a href="https://gitee.com/tao__tao/fastapi_vue3_admin.git">
<img src="https://gitee.com/tao__tao/fastapi_vue3_admin/badge/star.svg?theme=dark">
</a>
<a href="https://github.com/1014TaoTao/fastapi_vue3_admin.git">
<img src="https://img.shields.io/github/stars/1014TaoTao/fastapi_vue3_admin?style=social">
</a>
<a href="https://gitee.com/tao__tao/fastapi_vue3_admin/blob/master/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-orange">
</a>
<img src="https://img.shields.io/badge/Python-≥3.10-blue">
<img src="https://img.shields.io/badge/NodeJS-≥20.0-blue">
<img src="https://img.shields.io/badge/MySQL-≥8.0-blue">
<img src="https://img.shields.io/badge/Redis-≥7.0-blue">
</p>
</div>
English | [Chinese](./README.md)
## 📚 Project Introduction
**Fastapi-Vue3-Admin** is a fully open-source rapid development platform that provides free usage. It combines modern, high-performance technology stacks to help developers quickly build high-quality backend systems. The project directory structure is as follows:
```sh
fastapi_vue_admin
├─ backend # Backend project
├─ frontend # Frontend project
├─ devops # Deployment project
├─ mkdocs # Documentation project
├─ README.en.md # English documentation
└─ README.md # Chinese documentation
```
- **Backend**:
- **FastAPI**:A modern, high-performance asynchronous framework.
- **Swagger**:Automatically generates interactive API documentation.
- **Pydantic**:Enforces type constraints.
- **SQLAlchemy 2.0**:A powerful ORM library.
- **Frontend**:
- **Vue3**:A modern frontend framework.
- **Ant Design Vue**:An enterprise-level UI component library.
- **TypeScript**:Static type checking.
- **Vite**:A fast build tool.
- **Authentication**:OAuth2 using hashed passwords and JWT Bearer tokens.
- **Authorization Architecture**:Designed based on RBAC, supporting dynamic permission menus, button-level permission control, and data-level permission control.
- **Ready-to-use**:Suitable as a starting template for new projects, also useful for learning and reference.
If you find the project helpful, please give it a star!
## 🍻 Project Features
- Modular and loosely coupled
- Rich modules, ready-to-use
- Simple and easy to integrate
- Comprehensive documentation, easy to maintain
- Top-down, systematic design
- Unified framework, unified components, reducing selection costs
- Development standards, design patterns, code layering models
- Powerful and convenient development toolchain
- Complete local internationalization support
- Designed for team and enterprise use
## 📌 Built-in Modules
- **Dashboard**: Dashboard display, entry point for common features.
- **System Management**
- **Menu Management**:Configures system menus, operation permissions, and button permission identifiers.
- **Department Management**:Configures the organizational structure of the system, supports data permissions in tree structures.
- **Position Management**:Manages user positions.
- **Role Management**:Manages role menus and permission allocation, sets menu permissions for roles.
- **User Management**:Maintains and manages system users, including regular information maintenance and account settings.
- **Log Management**:Uniformly maintains commonly used and relatively fixed data in the system.
- **Config Management**:Maintains system configuration information, such as system parameters and system settings.
- **Notice Management**:Manages system notifications, such as system messages and system announcements.
- **Monitoring Management**
- **Online Users**:Views currently online users in the system.
- **Server Monitoring**:Views the system's runtime status, including memory, CPU, disk, etc.
- **Cache Monitoring**:Views system cache information, such as cache hit rate and cache keys.
- **Common Management**
- **API Management**:Maintains system APIs, such as API addresses and request methods.
- **Documentation Management**:Maintains system API documentation, supports online API calls.
## 🍪 Account Information
| Account Type | Username | Password |
| :--------- | :----- | :----- |
| **Admin Account** | admin | 123456 |
| **Demo Account** | demo | 123456 |
## 👷 Installation and Usage
### Version Information
| Type | Technology Stack | Version |
|----------|------------|------------|
| Backend | Python | 3.10 |
| Backend | FastAPI | 0.109 |
| Frontend | Node.js | >= 20.0（Recommended latest version）|
| Frontend | npm | 16.14 |
| Frontend | Vue3 | 3.3 |
| Database | MySQL | 8.0 Recommended latest version|
| Database | PostgreSQL | 14（Recommended latest version）|
| Database | MongoDB | 8.0（Recommended latest version）|
| Middleware | Redis | 7.0 Recommended latest version|
### Get the Code
```sh
git clone https://gitee.com/tao__tao/fastapi_vue3_admin.git
```
### Backend
1. Install dependencies
```shell
cd backend
pip3 install -r requirements.txt
When running pip install, I encountered the following error: UnicodeDecodeError: 'gbk' codec can't decode byte 0xad in position.
Solution Link：https://www.cnblogs.com/RexTooru/p/17303318.html
```
2. Modify project database configuration
The `DB_DRIVER` database driver type and the corresponding database configuration information are located in the `app/config/.env.dev (.env.test, .env.prod)` files.
3. Create a database named `fastapi_vue_admin`
4. Initialize database data
```shell
# Run in the root directory of the backend project (backend)
# This command will automatically generate tables and data in the database
# If the database has already been initialized, this command can be skipped
python3 main.py init
```
5. Start the backend
```shell
# Run in the root directory of the backend project (backend)
python3 main.py run
# If using Celery to manage tasks, you need to start Celery separately.
To start a regular task worker: celery -A celery_app.celery_app worker --loglevel=info
To start a periodic task scheduler (beat): celery -A celery_app.celery_app beat --loglevel=info
# After modifying the models, you need to: regenerate migration files and then apply migrations
# Generate migration
# python main.py revision "initial migration" --env=dev (default is dev if not specified)
# Apply migration
# python main.py upgrade --env=dev (default is dev if not specified)
```
### Frontend
1. Install dependencies
```shell
cd frontend
npm install
```
2. Run the frontend
```shell
npm run dev
```
3. Build the frontend
```shell
npm run build
```
### Access the Project
- Frontend URL: <http://127.0.0.1:5180>
- Username: `admin` Password: `123456`
- API URL: <http://127.0.0.1:8000/api/v1/docs>
## 🔧 Module Showcase
<table>
<tr>
<td><img src="./mkdocs/docs/resources/images/login.png"/>Login</td>
<td><img src="./mkdocs/docs/resources/images/dashboard.png"/>Dashboard</td>
</tr>
<tr>
<td><img src="./mkdocs/docs/resources/images/menu.png"/>Menu</td>
<td><img src="./mkdocs/docs/resources/images/dept.png"/>Department</td>
</tr>
<tr>
<td><img src="./mkdocs/docs/resources/images/position.png"/>Position</td>
<td><img src="./mkdocs/docs/resources/images/role.png"/>Role</td>
</tr>
<tr>
<td><img src="./mkdocs/docs/resources/images/user.png"/>User</td>
<td><img src="./mkdocs/docs/resources/images/log.png"/>Log</td>
</tr>
<tr>
<td><img src="./mkdocs/docs/resources/images/config.png"/>Config</td>
<td><img src="./mkdocs/docs/resources/images/online.png"/>Online</td>
</tr>
<tr>
<td><img src="./mkdocs/docs/resources/images/service.png"/>Server</td>
<td><img src="./mkdocs/docs/resources/images/cache.png"/>Cache</td>
</tr>
<tr>
<td><img src="./mkdocs/docs/resources/images/task.jpeg"/>Task</td>
<td><img src="./mkdocs/docs/resources/images/docs.png"/>API</td>
</tr>
<td><img src="./mkdocs/docs/resources/images/redoc.png"/>Documentation</td>
<td><img src="./mkdocs/docs/resources/images/info.png"/>Personal</td>
</tr>
</tr>
<td><img src="./mkdocs/docs/resources/images/help.png"/>Help</td>
</tr>
</table>
## ✨ Special Thanks
Thank you to the following projects for their contributions and support, which have made this project possible:
- [FastAPI Project](https://fastapi.tiangolo.com/)
- [Vue3 Project](https://v3.cn.vuejs.org/)
- [KInit Project](https://gitee.com/ktianc/kinit)
- [Fastapi-Vue3-Admin Project](https://gitee.com/senqi666/fastapi-vue-admin)
- [Vue-FastAPI-Admin Project](https://gitee.com/mizhexiaoxiao/vue-fastapi-admin)
- [RuoYi-Vue3-FastAPI Project](https://gitee.com/insistence2022/RuoYi-Vue3-FastAPI)
## 🎨 WeChat Group
The QR codes below are personal codes that can be used for technical discussions and to discuss various issues encountered during project usage. I sincerely hope everyone can optimize the project together and actively participate in discussions to support each other!！
### Personal QR Codes
<table>
<tr>
<td><img src="./mkdocs/docs/resources/images/微信.jpg"/></td>
<td><img src="./mkdocs/docs/resources/images/微信群.jpg"/></td>
<td><img src="./mkdocs/docs/resources/images/wechatPay.jpg"/></td>
</tr>
</table>
Reference in New Issue View Git Blame Copy Permalink