c6cd811093
- Create comprehensive root README.md with system overview and quick start - Create USER_MANUAL.md with complete user documentation in Traditional Chinese - Update backend/README.md with detailed project structure and features Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
172 lines
4.3 KiB
Markdown
172 lines
4.3 KiB
Markdown
# PROJECT CONTROL
|
|
|
|
跨部門專案管理系統 - 支援多維度任務追蹤、資源負載管理與即時協作。
|
|
|
|
## 功能特色
|
|
|
|
### 任務管理
|
|
- **多層級架構**: 空間 (Space) → 專案 (Project) → 任務 (Task) → 子任務 (SubTask)
|
|
- **多維視角**: 看板 (Kanban)、甘特圖 (Gantt)、行事曆 (Calendar)、列表 (List)
|
|
- **自訂欄位**: 下拉選單、公式計算、人員標籤、日期欄位
|
|
- **任務依賴**: 支援 FS/SS/FF/SF 四種依賴類型，自動循環檢測
|
|
|
|
### 資源管理
|
|
- **工作負載熱力圖**: 視覺化團隊工作分配
|
|
- **容量規劃**: 個人週時數設定與超載警示
|
|
- **專案健康度**: 風險評分與預警機制
|
|
|
|
### 協作功能
|
|
- **即時同步**: WebSocket 實現多人即時協作
|
|
- **評論系統**: 支援 @mention 通知
|
|
- **阻礙追蹤**: 任務阻礙管理與通知
|
|
|
|
### 安全與合規
|
|
- **稽核日誌**: 完整操作歷史追蹤
|
|
- **檔案加密**: AES-256 加密機密專案附件
|
|
- **CSRF 保護**: 跨站請求偽造防護
|
|
- **RBAC**: 角色權限控制
|
|
|
|
## 系統架構
|
|
|
|
```
|
|
┌─────────────────┐ ┌─────────────────┐
|
|
│ Frontend │────▶│ Backend │
|
|
│ React + TS │ │ FastAPI │
|
|
│ Port: 5173 │ │ Port: 8000 │
|
|
└─────────────────┘ └────────┬────────┘
|
|
│
|
|
┌────────────┼────────────┐
|
|
▼ ▼ ▼
|
|
┌─────────┐ ┌─────────┐ ┌─────────┐
|
|
│ MySQL │ │ Redis │ │ Files │
|
|
│ DB │ │ Cache │ │ Storage │
|
|
└─────────┘ └─────────┘ └─────────┘
|
|
```
|
|
|
|
## 快速開始
|
|
|
|
### 系統需求
|
|
|
|
| 軟體 | 版本 |
|
|
|------|------|
|
|
| Node.js | 18+ |
|
|
| Python | 3.11+ |
|
|
| MySQL | 8.0+ |
|
|
| Redis | 6.0+ |
|
|
|
|
### 安裝步驟
|
|
|
|
```bash
|
|
# 1. 複製專案
|
|
git clone <repository-url>
|
|
cd PROJECT\ CONTORL
|
|
|
|
# 2. 後端設定
|
|
cd backend
|
|
cp .env.example .env
|
|
# 編輯 .env 設定資料庫連線
|
|
pip install -r requirements.txt
|
|
alembic upgrade head
|
|
uvicorn app.main:app --reload --port 8000
|
|
|
|
# 3. 前端設定 (另開終端)
|
|
cd frontend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
### 存取服務
|
|
|
|
| 服務 | 網址 |
|
|
|------|------|
|
|
| 前端應用 | http://localhost:5173 |
|
|
| 後端 API | http://localhost:8000 |
|
|
| API 文件 | http://localhost:8000/docs |
|
|
|
|
## 專案結構
|
|
|
|
```
|
|
PROJECT CONTORL/
|
|
├── backend/ # FastAPI 後端
|
|
│ ├── app/ # 應用程式碼
|
|
│ ├── migrations/ # 資料庫遷移
|
|
│ └── tests/ # 測試檔案
|
|
├── frontend/ # React 前端
|
|
│ ├── src/ # 原始碼
|
|
│ └── public/ # 靜態資源
|
|
├── openspec/ # OpenSpec 規格文件
|
|
│ ├── specs/ # 功能規格
|
|
│ └── changes/ # 變更提案
|
|
├── DEPLOYMENT.md # 部署指南
|
|
├── USER_MANUAL.md # 使用者手冊
|
|
└── README.md # 本文件
|
|
```
|
|
|
|
## 文件索引
|
|
|
|
| 文件 | 說明 |
|
|
|------|------|
|
|
| [backend/README.md](backend/README.md) | 後端開發指南 |
|
|
| [frontend/README.md](frontend/README.md) | 前端開發指南 |
|
|
| [DEPLOYMENT.md](DEPLOYMENT.md) | 生產環境部署 |
|
|
| [USER_MANUAL.md](USER_MANUAL.md) | 使用者操作手冊 |
|
|
|
|
## 技術棧
|
|
|
|
### 前端
|
|
- React 18 + TypeScript
|
|
- Vite (建置工具)
|
|
- react-i18next (國際化)
|
|
- WebSocket (即時同步)
|
|
|
|
### 後端
|
|
- FastAPI (Web 框架)
|
|
- SQLAlchemy 2.0 (ORM)
|
|
- Alembic (資料庫遷移)
|
|
- Redis (快取/Session)
|
|
|
|
### 基礎設施
|
|
- MySQL 8.0 (主資料庫)
|
|
- Redis 6.0 (快取層)
|
|
- JWT (認證)
|
|
|
|
## 開發指令
|
|
|
|
### 後端
|
|
|
|
```bash
|
|
cd backend
|
|
|
|
# 執行測試
|
|
pytest -v
|
|
|
|
# 執行開發伺服器
|
|
uvicorn app.main:app --reload
|
|
|
|
# 資料庫遷移
|
|
alembic upgrade head
|
|
```
|
|
|
|
### 前端
|
|
|
|
```bash
|
|
cd frontend
|
|
|
|
# 開發模式
|
|
npm run dev
|
|
|
|
# 建置生產版本
|
|
npm run build
|
|
|
|
# 程式碼檢查
|
|
npm run lint
|
|
```
|
|
|
|
## 授權
|
|
|
|
此專案為私有專案，未經授權禁止使用。
|
|
|
|
## 聯絡資訊
|
|
|
|
如有問題，請聯繫系統管理員。
|