docs: 更新 README - 完善文档和示例数据说明
This commit is contained in:
@@ -12,8 +12,19 @@
|
|||||||
- 版主审核系统(申请、支持、审核流程)
|
- 版主审核系统(申请、支持、审核流程)
|
||||||
- RESTful API
|
- RESTful API
|
||||||
- Django Admin 后台
|
- Django Admin 后台
|
||||||
|
- ✅ 示例数据已导入
|
||||||
|
|
||||||
⏳ **前端 (React)** - 待开发
|
✅ **前端 (React)** - 核心页面完成
|
||||||
|
- 首页(Hero、省份导航、精选内容)
|
||||||
|
- 城市列表页(层级导航、面包屑)
|
||||||
|
- 区域详情页(标签页、统计信息)
|
||||||
|
- API 集成
|
||||||
|
|
||||||
|
⏳ **待开发**
|
||||||
|
- 文章详情页
|
||||||
|
- 服务详情页
|
||||||
|
- 用户登录/注册页
|
||||||
|
- 个人中心
|
||||||
|
|
||||||
## 技术栈
|
## 技术栈
|
||||||
|
|
||||||
@@ -23,10 +34,11 @@
|
|||||||
- JWT 认证
|
- JWT 认证
|
||||||
- SQLite (开发环境)
|
- SQLite (开发环境)
|
||||||
|
|
||||||
### 前端(计划)
|
### 前端
|
||||||
- React + Vite
|
- React + Vite
|
||||||
- Ant Design / Material UI
|
- React Router
|
||||||
- Axios
|
- Axios
|
||||||
|
- 原生 CSS
|
||||||
|
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
@@ -37,12 +49,26 @@ cd backend
|
|||||||
python3 manage.py runserver 0.0.0.0:8000
|
python3 manage.py runserver 0.0.0.0:8000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 前端启动
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
npm install
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
### 访问
|
### 访问
|
||||||
|
|
||||||
- **API**: http://localhost:8000/api/
|
- **后端 API**: http://localhost:8000/api/
|
||||||
- **Admin**: http://localhost:8000/admin/
|
- **Admin 后台**: http://localhost:8000/admin/
|
||||||
- 用户名:admin
|
- **前端页面**: http://localhost:3000/ (启动后)
|
||||||
- 密码:(创建时设置)
|
|
||||||
|
### 测试账号
|
||||||
|
|
||||||
|
| 用户名 | 密码 | 说明 |
|
||||||
|
|--------|------|------|
|
||||||
|
| admin | (创建时设置) | 超级管理员 |
|
||||||
|
| demo | demo123 | 示例用户 |
|
||||||
|
|
||||||
## API 端点
|
## API 端点
|
||||||
|
|
||||||
@@ -60,10 +86,12 @@ python3 manage.py runserver 0.0.0.0:8000
|
|||||||
### 文章
|
### 文章
|
||||||
- `GET /api/articles/` - 文章列表
|
- `GET /api/articles/` - 文章列表
|
||||||
- `POST /api/articles/` - 创建文章(需登录)
|
- `POST /api/articles/` - 创建文章(需登录)
|
||||||
|
- 查询参数:`?region={id}&type={type}`
|
||||||
|
|
||||||
### 特色服务
|
### 特色服务
|
||||||
- `GET /api/services/` - 服务列表
|
- `GET /api/services/` - 服务列表
|
||||||
- `POST /api/services/` - 创建服务(需登录)
|
- `POST /api/services/` - 创建服务(需登录)
|
||||||
|
- 查询参数:`?region={id}&category={category}`
|
||||||
|
|
||||||
### 评论
|
### 评论
|
||||||
- `GET /api/comments/` - 评论列表
|
- `GET /api/comments/` - 评论列表
|
||||||
@@ -76,7 +104,7 @@ python3 manage.py runserver 0.0.0.0:8000
|
|||||||
### 版主申请
|
### 版主申请
|
||||||
- `GET /api/moderator-applications/` - 申请列表
|
- `GET /api/moderator-applications/` - 申请列表
|
||||||
- `POST /api/moderator-applications/` - 创建申请(需登录)
|
- `POST /api/moderator-applications/` - 创建申请(需登录)
|
||||||
- `POST /api/moderator-applications/{id}/support/` - 支持申请(需登录)
|
- `POST /api/moderator-applications/{id}/support/` - 支持申请
|
||||||
|
|
||||||
## 数据库模型
|
## 数据库模型
|
||||||
|
|
||||||
@@ -100,27 +128,38 @@ python3 manage.py runserver 0.0.0.0:8000
|
|||||||
拒绝 拒绝
|
拒绝 拒绝
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 示例数据
|
||||||
|
|
||||||
|
已导入以下示例数据:
|
||||||
|
|
||||||
|
**省份 (6 个)**
|
||||||
|
- 北京市、上海市、广东省、浙江省、四川省、陕西省
|
||||||
|
|
||||||
|
**城市 (8 个)**
|
||||||
|
- 广州市、深圳市、杭州市、宁波市、成都市、绵阳市、西安市、咸阳市
|
||||||
|
|
||||||
|
**文章 (7 篇)**
|
||||||
|
- 北京故宫游览攻略、上海外滩历史、广州早茶文化等
|
||||||
|
|
||||||
|
**特色服务 (6 个)**
|
||||||
|
- 全聚德烤鸭、东方明珠塔、广州塔、楼外楼、宽窄巷子、大唐不夜城
|
||||||
|
|
||||||
## 下一步计划
|
## 下一步计划
|
||||||
|
|
||||||
1. **前端开发** - React 页面
|
1. **完善前端页面**
|
||||||
- 首页
|
- 文章详情页
|
||||||
- 城市列表
|
- 服务详情页
|
||||||
- 城市详情页
|
- 登录/注册页
|
||||||
- 特色服务列表
|
- 个人中心
|
||||||
- 用户中心
|
|
||||||
|
|
||||||
2. **API 完善**
|
2. **AI 审核集成**
|
||||||
- 搜索功能
|
|
||||||
- 分页优化
|
|
||||||
- 数据统计
|
|
||||||
|
|
||||||
3. **AI 审核集成**
|
|
||||||
- 接入 AI 审核 API
|
- 接入 AI 审核 API
|
||||||
- 自动审核规则
|
- 自动审核规则
|
||||||
|
|
||||||
4. **数据初始化**
|
3. **功能增强**
|
||||||
- 导入示例城市数据
|
- 搜索功能
|
||||||
- 创建测试内容
|
- 分页优化
|
||||||
|
- 数据统计
|
||||||
|
|
||||||
## 开发日志
|
## 开发日志
|
||||||
|
|
||||||
@@ -134,3 +173,8 @@ python3 manage.py runserver 0.0.0.0:8000
|
|||||||
- ✅ 实现版主审核系统
|
- ✅ 实现版主审核系统
|
||||||
- ✅ 配置 REST API
|
- ✅ 配置 REST API
|
||||||
- ✅ 启动开发服务器
|
- ✅ 启动开发服务器
|
||||||
|
- ✅ 创建示例数据导入命令
|
||||||
|
- ✅ 导入示例数据(6 省 8 市 7 文章 6 服务)
|
||||||
|
- ✅ 前端页面开发(首页/城市列表/区域详情)
|
||||||
|
- ✅ API 集成(axios + react-router)
|
||||||
|
- ✅ Git 提交
|
||||||
|
|||||||
Reference in New Issue
Block a user