add docs 结构

This commit is contained in:
xie7654
2025-07-05 23:18:24 +08:00
parent 2de86a86a6
commit 6a43b29c1f
26 changed files with 146 additions and 595 deletions

View File

@@ -0,0 +1,5 @@
{
"label": "文档",
"position": 1
}

View File

@@ -0,0 +1,15 @@
---
sidebar_position: 8
---
# 后端手册
## 目录结构
- backend/backendDjango 主程序
- backend/system系统相关模块
- backend/utils工具类
- backend/static静态文件
## 常用命令
- 数据迁移:`python manage.py migrate`
- 创建超级用户:`python manage.py createsuperuser`
- 启动服务:`python manage.py runserver`

View File

@@ -0,0 +1,13 @@
---
sidebar_position: 5
---
# 部署
1. 克隆项目代码
2. 安装依赖(前后端)
3. 配置数据库与环境变量
4. 运行数据库迁移
5. 启动后端服务
6. 启动前端服务
可根据实际环境选择 Docker 或传统部署方式。

View File

@@ -0,0 +1,14 @@
---
sidebar_position: 7
---
# Docker 项目部署(生产环境)
1. 配置生产环境变量和数据库
2. 构建前端静态文件并拷贝到后端 static 目录
3. 执行:
```bash
docker-compose -f docker-compose.prod.yml up -d --build
```
4. 检查服务状态,确保一切正常。

View File

@@ -0,0 +1,13 @@
---
sidebar_position: 6
---
# Docker 启动
1. 安装 Docker 与 Docker Compose
2. 在项目根目录执行:
```bash
docker-compose -f docker-compose.dev.yml up -d
```
3. 访问前后端服务地址,默认端口可在 compose 文件中查看和修改。

View File

@@ -0,0 +1,16 @@
---
sidebar_position: 2
---
# 功能列表
- 用户与权限管理
- 菜单与角色管理
- 部门管理
- 数据字典
- 日志审计
- 多端前端支持Antd、Element、Naive
- Docker 一键部署
- API 接口自动生成
- 多环境配置
- 任务调度Celery
- 代码生成器

View File

@@ -0,0 +1,14 @@
---
sidebar_position: 9
---
# 前端手册
## 目录结构
- web/apps/web-antdAnt Design Vue 版本
- web/apps/web-eleElement Plus 版本
- web/apps/web-naiveNaive UI 版本
## 常用命令
- 安装依赖:`pnpm install`
- 启动开发:`pnpm dev`
- 打包构建:`pnpm build`

View File

@@ -0,0 +1,6 @@
---
sidebar_position: 1
---
# 介绍
django-vue3-admin 是一个基于 Django 后端与 Vue3 前端的全栈管理系统解决方案,集成了权限管理、菜单管理、用户管理等常用功能,支持多种前端框架,适合中后台管理系统开发。

View File

@@ -0,0 +1,13 @@
---
sidebar_position: 4
---
# 快速启动(后端)
```bash
cd backend
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver
```
访问 http://127.0.0.1:8000/ 进入后端管理。

View File

@@ -0,0 +1,14 @@
---
sidebar_position: 3
---
# 快速启动-前端
以 web-antd 为例:
```bash
cd web/apps/web-antd
pnpm install
pnpm dev
```
其他前端web-ele、web-naive步骤类似进入对应目录执行安装与启动命令。