# rapid-admin

**Repository Path**: YueXia_1/rapid-admin

## Basic Information

- **Project Name**: rapid-admin
- **Description**: 一个专注于API管理的开源项目，提供高效、安全的后端管理解决方案，适用于快速开发和部署API服务。
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 0
- **Created**: 2025-05-19
- **Last Updated**: 2025-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Rapid Admin System

<div align="center">
  <img src="./rapid-api/static/logo.png" alt="后端 Logo" width="180"/>
  <img src="./rapid-soybean/public/favicon.svg" alt="前端 Logo" width="160"/>
</div>

<div align="center">

![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)
![FastAPI](https://img.shields.io/badge/FastAPI-0.115.12-green.svg)
![SQLAlchemy](https://img.shields.io/badge/SQLAlchemy-2.x-orange.svg)
![Vue3](https://img.shields.io/badge/Vue3-3.x-green.svg)
![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)
![Vite](https://img.shields.io/badge/Vite-5.x-purple.svg)
![License](https://img.shields.io/badge/License-MIT-yellow.svg)

一个现代化、优雅且功能强大的后台管理系统，提供完整的前后端解决方案。

</div>

## 🌟 系统特性

### 后端特性
- 完整的用户认证和授权系统
  - JWT Token 认证
  - 角色权限管理
  - 操作日志记录
  - 登录日志记录
- 多数据库支持
  - MySql (主数据库)
  - Redis (缓存)
  - MongoDB (日志存储)
- 系统功能
  - 演示环境模式
  - 文件上传
  - IP 地址解析
  - 数据脱敏
- Funboost 分布式任务队列
  - 异步任务处理
  - 定时任务
  - 多种消息中间件支持

### 内置功能模块
- 👥 用户管理
  - 用户是系统操作者，该功能主要完成系统用户配置
  ![用户管理](./docs/images/user-management.png)

- 👮 角色管理
  - 角色菜单权限分配
  - 设置角色按机构进行数据范围权限划分
  ![角色管理](./docs/images/role-management.png)

- 📝 菜单管理
  - 配置系统菜单
  - 操作权限配置
  - 按钮权限标识配置
  ![菜单管理](./docs/images/menu-management.png)

- 🏢 部门管理
  - 配置系统组织机构
  - 支持多级部门结构

- 💼 岗位管理
  - 配置系统用户所属担任职务

- 📚 字典管理
  - 对系统中经常使用的一些较为固定的数据进行维护
  - 支持字典类型和字典数据管理

- 📋 日志管理
  - 操作日志：系统正常操作日志记录和查询
  - 登录日志：系统登录日志记录查询包含登录异常
  - 异常日志：系统异常信息日志记录和查询

- 📊 系统监控
  - 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息
  - 缓存监控：对系统的缓存信息查询，命令统计等
  ![系统监控](./docs/images/monitor.png)
  ![Redis监控](./docs/images/redis.png)

- ⏰ 任务调度
  - 定时任务：在线（添加、修改、删除）任务调度
  - 任务日志：包含执行结果日志
  - 多进程启动不会出现重复执行
  ![任务调度](./docs/images/task-scheduler.png)
  ![任务速率](./docs/images/task-scheduler2.png)

### 系统界面预览
![登录界面](./docs/images/login.png)
![个人中心](./docs/images/profile.png)

### 前端特性
> 前端基于开源的 [SoybeanAdmin](https://github.com/soybeanjs/soybean-admin) 进行二次开发，感谢 SoybeanAdmin 团队提供的优秀模板。

- 现代化技术栈：Vue3、Vite5、TypeScript、Pinia、UnoCSS
- 清晰的项目架构，采用 pnpm monorepo
- 严格的代码规范，集成 ESLint、Prettier 和 simple-git-hooks
- 丰富的主题配置
- 内置国际化方案
- 自动化文件路由系统
- 灵活的权限路由
- 丰富的页面组件
- 移动端适配
- 命令行工具

## 🛠️ 技术栈

### 后端
- Python 3.10+
- FastAPI
- SQLAlchemy 2.x
- Advanced Alchemy
- Redis
- MongoDB
- Poetry (依赖管理)
- Pydantic Settings
- Funboost (分布式任务队列)

### 前端
> 基于 [SoybeanAdmin](https://github.com/soybeanjs/soybean-admin) 开发

- Vue3
- Vite5
- TypeScript
- Pinia
- UnoCSS
- NaiveUI/AntDesignVue
- pnpm

## 🚀 快速开始

### 后端设置

1. 安装 Python 3.10+ 和 Poetry
2. 克隆仓库并进入后端目录：
```bash
cd rapid-api
```

3. 安装依赖：
```bash
poetry install
```

4. 配置环境：
   - 复制 `config/example.yaml` 到 `config/dev.yaml`
   - 设置环境变量：
     ```bash
     # Windows
     $env:APP_ENV="prod"
     
     # Linux
     export APP_ENV="prod"
     ```

5. 初始化数据库：
```bash
alchemy --config path.to.alchemy-config.config init [DIRECTORY]
alchemy --config path.to.alchemy-config.config make-migrations
alchemy --config path.to.alchemy-config.config upgrade [REVISION]
```

6. 启动后端服务：
```bash
python main.py
```

### 前端设置

1. 确保已安装：
   - Git
   - NodeJS >= 18.12.0 (推荐 18.19.0+)
   - pnpm >= 8.7.0 (推荐 8.14.0+)

2. 进入前端目录：
```bash
cd rapid-soybean
```

3. 安装依赖：
```bash
pnpm i
```

4. 启动开发服务器：
```bash
pnpm dev
```

5. 构建生产版本：
```bash
pnpm build
```

## 📚 文档

- 后端 API 文档：http://localhost:9000/docs
- 前端文档：https://docs.soybeanjs.cn

## 🤝 贡献指南

我们欢迎各种形式的贡献。如果您有任何想法或建议，欢迎通过以下方式参与：

1. 提交 Pull Request
2. 创建 Issue
3. 完善文档
4. 修复 Bug
5. 添加新功能

## 📄 许可证

[MIT License](LICENSE)

## 💬 交流

如果您在使用过程中遇到任何问题，或者有任何建议，欢迎通过以下方式联系我们：

- 提交 Issue
- 发送邮件
- 加入技术交流群

## 🌟 致谢

感谢所有为本项目做出贡献的开发者！