# initial_django_vue

**Repository Path**: ycvayne/initial_django_vue

## Basic Information

- **Project Name**: initial_django_vue
- **Description**: 最小化的管理端。包括vue前端 + django后端。一键启动，rbac权限管理
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-27
- **Last Updated**: 2025-12-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[English](./) | [中文](./README_CN.md)

## 目录

- [目录](#目录)
- [📖 项目描述](#-项目描述)
- [✨ 功能特性](#-功能特性)
- [🚀 快速开始](#-快速开始)
  - [环境要求](#环境要求)
  - [启动](#启动)
  - [访问](#访问)
  - [内置用户](#内置用户)
  - [更多命令](#更多命令)
- [一些配置](#一些配置)
  - [环境变量配置](#环境变量配置)
  - [前端图标配置](#前端图标配置)
  - [系统标题配置](#系统标题配置)
  - [i18n](#i18n)
- [参考文档：](#参考文档)

## 📖 项目描述

- 最小化全栈开发基础框架，支持 RBAC 权限管理系统。包括前端、后端、nginx、mysql、redis。
- 技术栈： `Python 3.13`、`Django 5.2`、`Vue 3.5`。
- 代码结构见[这里](./docs/code_arch.md)。

## ✨ 功能特性

**用户体系**

- ✅ 本地用户：增删改查
- ✅ 本地用户：用户自行修改密码、管理员重置密码
- ✅ 本地用户：密码复杂度配置、登录锁定配置
- ✅ 密码加密存储（本地用户密码无法逆向破解）
- ✅ 允许配置对接 LDAP 用户（ldap用户只记录，不存储、修改用户密码）

**权限体系**

- ✅ 基础RABC：管理：权限（JSON格式）、角色、用户组（可继承）
- ✅ json格式权限，可以参考已有的系统默认权限进行新权限配置。（前端、后端权限均可配置）
- ✅ 系统权限不允许删除

**审计日志**

- ✅ 登录日志：用户登录、退出、失败登录
- ✅ 操作日志：以模型为维度，记录所有模型的增删改。

**OAuth2/OIDC 集成**

- ✅ 标准 OAuth2 提供商，使用 ORY Hydra
- ✅ OpenID Connect (OIDC) 支持身份验证
- ✅ OAuth2 客户端管理界面
- ✅ 与现有用户和权限系统集成
- ✅ 支持授权码、客户端凭证等多种授权类型
- ✅ ID Token 支持用户身份信息

**前端特性**

- ✅ 动态菜单（根据权限动态生成）
- ✅ 中英文切换

## 🚀 快速开始

### 环境要求

- `Docker Engine 18.06.0`
- `Docker Compose 3.7+` 

### 启动

> 注意：
>
> - 最好在服务器使用。
> - 个人电脑使用，配置不高的情况下，前端打包时，电脑负载会很高。

```bash
docker-compose -f docker-compose.prod.yaml up -d
```

### 访问

http://localhost:8080/

### 内置用户

| 角色 | 账号 | 密码 |
| ---- | ---- | ---- |
| 管理员 | admin | Admin@123 |

### 更多命令

```bash
# 停止
docker-compose -f docker-compose.prod.yaml down

# 清理数据
./clean.sh
```

## 一些配置

### 环境变量配置

| 作用 | 文件 |
| ---- | ---- |
| 【前端】vue工程配置 | [./code/frontend/.env.production](./code/frontend/.env.production) |
| 【前端】Pure Admin配置 | [./code/frontend/public/platform-config.json](./code/frontend/public/platform-config.json) <br/> [./code/frontend/public/platform-config.json.explain](./code/frontend/public/platform-config.json.explain) |
| 【后端】业务配置 | [code/backend/.prod.yaml](code/backend/.prod.yaml) |
| 【后端】全量路由定义文件 | [code/backend/base_routes.json](code/backend/base_routes.json) |
| 【后端】docker环境变量 | `code/backend/.prod.env` |

### 前端图标配置

- 图标：`code/frontend/public/favicon.ico`
- logo：`code/frontend/public/logo.png`
- user-avatar：`code/frontend/src/assets/user.jpg`

### 系统标题配置

- `code/frontend/public/platform-config.json`: Title
- `code/frontend/src/views/monitor/dashboard/index.vue`: title

### i18n

- [这是i18n 的英文文件](./code/frontend/src/i18n/locales/en-US.json)
- [这是i18n 的中文文件](./code/frontend/src/i18n/locales/zh-CN.json)

## 参考文档：
- [示例readme](https://blog.csdn.net/gitblog_00002/article/details/150695762)
- [readme编写](https://github.com/guodongxiaren/README)
- [readme编写:图标](https://github.com/guodongxiaren/README/blob/master/emoji.md)
- [为markdown文件生成目录](https://zhuanlan.zhihu.com/p/126353341)