https://github.com/xingwd/xadmin

FastAPI + Vue 全栈项目模板
https://github.com/xingwd/xadmin

fastapi vue

Last synced: 2 months ago
JSON representation

FastAPI + Vue 全栈项目模板

• Host: GitHub
• URL: https://github.com/xingwd/xadmin
• Owner: Xingwd
• License: mit
• Created: 2025-03-21T07:04:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-02T06:57:35.000Z (about 1 year ago)
• Last Synced: 2025-04-02T07:32:53.162Z (about 1 year ago)
• Topics: fastapi, vue
• Language: Vue
• Homepage:
• Size: 4.51 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# XAdmin

项目框架及后端基于 [Full Stack FastAPI Template](https://github.com/fastapi/full-stack-fastapi-template) 二次开发。

前端基于 [BuildAdmin](https://github.com/build-admin/buildadmin) 二次开发。

## 技术栈和特性

- ⚡ [**FastAPI**](https://fastapi.tiangolo.com) 用于Python后端API。

  - 🧰 [SQLModel](https://sqlmodel.tiangolo.com) 用于Python和SQL数据库的集成（ORM）。

  - 🔍 [Pydantic](https://docs.pydantic.dev) FastAPI的依赖项之一，用于数据验证和配置管理。

  - 💾 [PostgreSQL](https://www.postgresql.org) 作为SQL数据库。

- 🚀 [Vue](https://vuejs.org) 用于前端。

  - 💃 使用了TypeScript、Vite和其他一些现代化的前端技术栈。

  - 🎨 [Element Plus](https://element-plus.org) 用于前端组件。

  - 📊 [AntV](https://antv.antgroup.com) 用于可视化组件。

  - 🤖 一个自动化生成的前端客户端。

  - 🦇 支持暗黑主题（Dark mode）。

- 🐋 [Docker Compose](https://www.docker.com) 用于开发环境和生产环境。

- 🔒 默认使用密码哈希来保证安全。

- 🔑 JWT (JSON Web Token) 令牌和 Oauth2 用于权限验证。

- ✅ 单元测试用了 [Pytest](https://pytest.org)。

- 📞 [Traefik](https://traefik.io) 用于反向代理和负载均衡。

### 登录页

[![Login Page](img/login.png)](https://github.com/Xingwd/xadmin)

### 主页

[![Home Page](img/home.png)](https://github.com/Xingwd/xadmin)

[![Home Page Dark](img/home-dark.png)](https://github.com/Xingwd/xadmin)

### 布局配置

[![Layout Setting](img/layout-setting.png)](https://github.com/Xingwd/xadmin)

### 常规管理 - 个人信息

[![Routine UserInfo Page](img/routine-userInfo.png)](https://github.com/Xingwd/xadmin)

### 系统管理 - 规则管理

[![System Rule](img/system-rule.png)](https://github.com/Xingwd/xadmin)

[![System Rule Create](img/system-rule-create.png)](https://github.com/Xingwd/xadmin)

[![System Rule Edit](img/system-rule-edit.png)](https://github.com/Xingwd/xadmin)

### 系统管理 - 角色管理

[![System Role](img/system-role.png)](https://github.com/Xingwd/xadmin)

[![System Role Info](img/system-role-info.png)](https://github.com/Xingwd/xadmin)

[![System Role Create](img/system-role-create.png)](https://github.com/Xingwd/xadmin)

[![System Role Edit](img/system-role-edit.png)](https://github.com/Xingwd/xadmin)

### 系统管理 - 用户管理

[![System User](img/system-user.png)](https://github.com/Xingwd/xadmin)

[![System User Create](img/system-user-create.png)](https://github.com/Xingwd/xadmin)

[![System User Edit](img/system-user-edit.png)](https://github.com/Xingwd/xadmin)

### 系统管理 - 操作日志

[![System Operation Log](img/system-operation-log.png)](https://github.com/Xingwd/xadmin)

### 交互式 API 文档

[![API docs](img/api-docs.png)](https://github.com/Xingwd/xadmin)

### 配置

你可以更新 `.env` 文件中的配置，以自定义你的配置。

在部署之前，请确保至少更改以下值：

- `SECRET_KEY`

- `FIRST_SUPERUSER_PASSWORD`

- `POSTGRES_PASSWORD`

你可以（并且应该）以环境变量的形式传递这些机密内容。

阅读 [deployment.md](./deployment.md) 文档以了解更多详细信息。

### 生成 Secret Keys

`.env` 文件中的一些环境变量的默认值为 `changethis`。

你必须用一个密钥来更改它们，要生成密钥，你可以运行以下命令：

```bash

python -c "import secrets; print(secrets.token_urlsafe(32))"

```

复制内容并将其用作密码/密钥。然后再次运行以生成另一个安全密钥。

## 后端开发

后端文档：[backend/README.md](./backend/README.md).

## 前端开发

前端文档：[frontend/README.md](./frontend/README.md).

## 通用开发

通用开发文档：[development.md](./development.md).

这包括使用 Docker Compose、自定义本地域、`.env` 配置等。

## 部署

部署文档：[deployment.md](./deployment.md).

## License

XAdmin 依据 MIT license 获得授权。