dramaling-vocab-learning/docs/03_development/README.md

78 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# DramaLing 開發文檔總覽
## 📚 文檔結構
### 🎯 **當前有效文檔**
#### API 開發文檔
- **[api/backend-development-plan.md](./api/backend-development-plan.md)** - 完整後端開發計劃
- **[api/phase1-implementation-guide.md](./api/phase1-implementation-guide.md)** - Phase 1 實作指南
- **[api/README.md](./api/README.md)** - API 文檔導覽
#### 專案設定文檔
- **[setup/folder-structure.md](./setup/folder-structure.md)** - 專案資料夾結構指南
- **[setup/env-setup.md](./setup/env-setup.md)** - 環境設定指南
- **[setup/initial-setup.md](./setup/initial-setup.md)** - 初始專案設定
- **[setup/error-handling.md](./setup/error-handling.md)** - 錯誤處理設定
#### 開發流程文檔
- **[git-workflow.md](./git-workflow.md)** - Git 工作流程
- **[simple-dev-workflow.md](./simple-dev-workflow.md)** - 簡化開發流程
- **[claude-code-development-sop.md](./claude-code-development-sop.md)** - Claude Code 開發 SOP
## 🎯 **開發指南**
### 後端開發
1. **主要參考**: `api/backend-development-plan.md`
2. **實作指南**: `api/phase1-implementation-guide.md`
3. **當前進度**: Phase 1 開發中
### 前端開發
- 前端已實作完成,代碼位於 `/app` 目錄
- 使用 Next.js 14 App Router
- 狀態管理React hooks (useState, useEffect)
- UI 框架Tailwind CSS + shadcn/ui
### 專案設定
- **環境設定**: `setup/env-setup.md`
- **資料夾結構**: `setup/folder-structure.md`
- **錯誤處理**: `setup/error-handling.md`
## 🚀 **快速開始**
### 1. 後端開發
```bash
# 查看後端開發計劃
cat docs/03_development/api/backend-development-plan.md
# 開始 Phase 1 實作
cat docs/03_development/api/phase1-implementation-guide.md
```
### 2. 環境設定
```bash
# 查看環境設定指南
cat docs/03_development/setup/env-setup.md
```
### 3. 專案結構
```bash
# 查看資料夾結構指南
cat docs/03_development/setup/folder-structure.md
```
## 📊 **文檔更新狀態**
-**最新** - 基於實際前端實作和需求規格書
- 🔄 **持續更新** - 隨開發進度同步更新
- 📦 **已清理** - 移除過時和衝突的文檔
## 📞 **需要幫助?**
- **後端開發問題**: 查看 `api/` 目錄下的文檔
- **環境設定問題**: 查看 `setup/` 目錄下的文檔
- **開發流程問題**: 查看根目錄下的工作流程文檔
---
> **注意**: 所有歸檔的文檔僅供參考,請以當前有效文檔為準。