117 lines
2.4 KiB
Markdown
117 lines
2.4 KiB
Markdown
# 云盘应用 (Cloud Drive Application)
|
||
|
||
一个现代化的云存储Web应用，支持文件管理、用户认证、安全存储等功能。
|
||
|
||
## 🚀 技术栈
|
||
|
||
### 前端
|
||
- **React 19** - UI框架
|
||
- **TypeScript** - 类型安全
|
||
- **Vite 5** - 构建工具
|
||
- **TailwindCSS 4** - 样式框架
|
||
- **shadcn/ui** - 组件库
|
||
|
||
### 后端
|
||
- **Python 3.12** - 编程语言
|
||
- **FastAPI** - Web框架
|
||
- **Pydantic V2** - 数据验证
|
||
- **SQLAlchemy** - ORM框架
|
||
|
||
### 数据库
|
||
- **MySQL 8.0** - 主数据库
|
||
- **Redis 7** - 缓存和会话
|
||
|
||
### 认证
|
||
- **JWT** - 身份验证
|
||
- **BCrypt** - 密码加密
|
||
|
||
## 📁 项目结构
|
||
|
||
```
|
||
full-stack-doc/
|
||
├── frontend/ # React前端应用
|
||
├── backend/ # FastAPI后端应用
|
||
├── docs/ # 项目文档
|
||
├── scripts/ # 部署和工具脚本
|
||
├── docker-compose.yml # Docker编排配置
|
||
└── README.md # 项目说明
|
||
```
|
||
|
||
## 🛠️ 开发环境启动
|
||
|
||
### 前置要求
|
||
- Docker & Docker Compose
|
||
- Node.js 18+
|
||
- Python 3.12+
|
||
|
||
### 一键启动
|
||
```bash
|
||
# 启动所有服务
|
||
docker-compose up -d
|
||
|
||
# 查看服务状态
|
||
docker-compose ps
|
||
|
||
# 查看日志
|
||
docker-compose logs -f
|
||
```
|
||
|
||
### 访问地址
|
||
- 前端应用: http://localhost:3000
|
||
- 后端API: http://localhost:8000
|
||
- API文档: http://localhost:8000/docs
|
||
- 健康检查: http://localhost:8000/api/v1/health
|
||
|
||
## 📚 开发文档
|
||
|
||
详细文档请查看 `docs/` 目录：
|
||
- [产品需求文档](docs/prd.md)
|
||
- [技术架构文档](docs/architecture.md)
|
||
- [UI/UX设计指南](docs/ui-ux-design-guide.md)
|
||
- [用户故事](docs/stories/)
|
||
|
||
## 🧪 测试
|
||
|
||
```bash
|
||
# 后端测试
|
||
cd backend && python -m pytest
|
||
|
||
# 前端测试
|
||
cd frontend && npm test
|
||
|
||
# E2E测试
|
||
npm run test:e2e
|
||
```
|
||
|
||
## 🚀 部署
|
||
|
||
```bash
|
||
# 生产环境部署
|
||
./scripts/deploy.sh
|
||
|
||
# 开发环境部署
|
||
./scripts/dev-deploy.sh
|
||
```
|
||
|
||
## 🤝 贡献指南
|
||
|
||
1. Fork 项目
|
||
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
|
||
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
|
||
4. 推送到分支 (`git push origin feature/AmazingFeature`)
|
||
5. 打开 Pull Request
|
||
|
||
## 📄 许可证
|
||
|
||
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
|
||
|
||
## 👥 团队
|
||
|
||
- **产品经理**: John
|
||
- **架构师**: Alex
|
||
- **敏捷教练**: Sarah
|
||
- **开发团队**: 全栈开发工程师
|
||
|
||
---
|
||
|
||
*开始开发云盘应用，构建安全、高效的文件管理平台！* 🚀 |