docs: 添加部署指南和更新 README

- DEPLOYMENT.md(详细部署指南)
- 更新 README.md(项目信息、功能特性、快速开始)
- 添加 Docker 部署说明
- 添加文档链接
This commit is contained in:
mashen
2026-04-09 13:50:11 +00:00
parent e627e3f579
commit 6f3b74639c
2 changed files with 532 additions and 42 deletions

101
README.md
View File

@@ -1,6 +1,22 @@
# React + Django Full-Stack Project
## Tech Stack
## 项目信息
**项目名称:** 城市手册CityWiki
**项目定位:** 地方志兼本地生活服务平台
**技术栈:** React + Django + PostgreSQL + Docker
## 功能特性
- ✅ 用户认证系统注册、登录、JWT
- ✅ 版块层级管理(省→市→县→乡镇→村)
- ✅ 文章管理(创建、审核、发布)
- ✅ 特色服务(衣食住行娱乐旅游文化)
- ✅ 交互功能(评论、评分、点赞、收藏)
- ✅ 版主管理(申请、权限、审核)
- ✅ 内容审核流程(版主初审 + AI 审核)
## 技术栈
### Backend
- Django 4.2
@@ -11,13 +27,13 @@
### Frontend
- React 18 (Create React App)
- MobX (state management)
- MobX (状态管理)
- styled-components (CSS-in-JS)
- React Router
### Deployment
- Docker & Docker Compose
- Nginx (reverse proxy)
- Nginx (反向代理)
## Project Structure
@@ -39,85 +55,86 @@
└── .env.example
```
## Setup Instructions
## 快速开始
### 1. Environment Variables
### 1. 克隆项目
Copy `.env.example` to `.env` and configure:
```bash
git clone http://10.2.0.100:8989/mashen/chengshishouce.git
cd chengshishouce
```
### 2. 环境变量配置
```bash
cp .env.example .env
# 编辑 .env 文件,配置数据库和其他设置
```
Update the following variables:
- `DJANGO_SECRET_KEY` - Generate a secure secret key
- Database credentials (DB_NAME, DB_USER, DB_PASSWORD)
- `ALLOWED_HOSTS` - Add your domain(s)
### 2. PostgreSQL Configuration
If using external PostgreSQL (already deployed):
Update `.env` with your database credentials:
```env
DB_HOST=your-db-host
DB_PORT=5432
DB_NAME=your_database_name
DB_USER=your_database_user
DB_PASSWORD=your_database_password
```
If using Docker PostgreSQL:
The default values in `docker-compose.yml` will work.
### 3. Backend Setup
### 3. 后端启动
```bash
cd backend
# Create virtual environment
# 创建虚拟环境
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
source venv/bin/activate # Windows: venv\Scripts\activate
# Install dependencies
# 安装依赖
pip install -r requirements.txt
# Run migrations
# 运行迁移
python manage.py migrate
# Create superuser
# 创建超级用户
python manage.py createsuperuser
# Run development server
# 启动开发服务器
python manage.py runserver
```
### 4. Frontend Setup
### 4. 前端启动
```bash
cd frontend
# Install dependencies
# 安装依赖
npm install
# Start development server
# 启动开发服务器
npm start
```
### 5. Docker Deployment
### 5. 访问应用
- 前端http://localhost:3000
- 后端 APIhttp://localhost:8000
- GraphQLhttp://localhost:8000/graphql
- Django Adminhttp://localhost:8000/admin
## Docker 部署
```bash
# Build and start all services
# 构建并启动所有服务
docker-compose up -d
# View logs
# 查看日志
docker-compose logs -f
# Stop services
# 停止服务
docker-compose down
```
详细部署指南请参考 [DEPLOYMENT.md](./DEPLOYMENT.md)
## 项目文档
- [需求文档](./城市手册需求文档.md) - 项目需求说明
- [实施计划](./REQUIREMENTS_IMPLEMENTATION.md) - 需求实施进度
- [部署指南](./DEPLOYMENT.md) - 详细部署说明
- [技术文档](./PROJECT_DOCS.md) - 架构和技术文档
- [API 测试](./TESTING.md) - API 测试指南
## API Endpoints
### REST API