zhi
f34538e3b0
- Frontend: remove nginx, use serve for static files - Frontend: add Projects/Milestones/Notifications pages - Frontend: fix auth endpoint to match backend (/auth/token) - docker-compose: configurable ports via env vars, reduce frontend resources - Add nginx-host.conf.example for host-level reverse proxy - Add .env.example - Update README with deployment architecture
66 lines
1.7 KiB
Markdown
66 lines
1.7 KiB
Markdown
# HarborForge
|
||
|
||
Agent/人类协同任务管理平台
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
HarborForge/
|
||
├── HarborForge.Backend/ # 后端 (FastAPI + MySQL)
|
||
├── HarborForge.Frontend/ # 前端 (React + Vite)
|
||
├── docker-compose.yml # Docker 部署配置
|
||
├── nginx-host.conf.example # 宿主机 nginx 配置示例
|
||
└── .env.example # 环境变量模板
|
||
```
|
||
|
||
## 快速开始
|
||
|
||
```bash
|
||
# 克隆并初始化子模块
|
||
git clone https://git.hangman-lab.top/zhi/HarborForge.git
|
||
cd HarborForge
|
||
git submodule update --init --recursive
|
||
|
||
# 配置环境变量
|
||
cp .env.example .env
|
||
|
||
# 启动服务
|
||
docker compose up -d
|
||
```
|
||
|
||
## 部署架构
|
||
|
||
```
|
||
宿主机 nginx (80/443)
|
||
├── / → frontend (Docker, port 3000)
|
||
└── /api/ → backend (Docker, port 8000)
|
||
```
|
||
|
||
前端 Docker 容器不包含 nginx，使用轻量的 `serve` 提供静态文件。
|
||
API 代理由宿主机 nginx 统一处理。
|
||
|
||
### 宿主机 nginx 配置
|
||
|
||
参考 `nginx-host.conf.example`，复制到 `/etc/nginx/sites-available/` 并修改域名。
|
||
|
||
## 子模块
|
||
|
||
- [HarborForge.Backend](https://git.hangman-lab.top/zhi/HarborForge.Backend) - FastAPI 后端 API
|
||
- [HarborForge.Frontend](https://git.hangman-lab.top/zhi/HarborForge.Frontend) - React 前端
|
||
|
||
## 端口
|
||
|
||
| 服务 | 默认端口 | 环境变量 |
|
||
|------|----------|----------|
|
||
| Frontend | 3000 | `FRONTEND_PORT` |
|
||
| Backend | 8000 | `BACKEND_PORT` |
|
||
| MySQL | 3306 | `MYSQL_PORT` |
|
||
|
||
## 前端页面
|
||
|
||
- 📊 仪表盘 — 统计概览
|
||
- 📋 Issues — 创建、列表、详情、状态变更、评论
|
||
- 📁 项目 — 项目管理、成员、关联 issue
|
||
- 🏁 里程碑 — 进度追踪、完成百分比
|
||
- 🔔 通知 — 实时通知中心、未读计数
|