9cea5cfd4e
- Move fastAPI from root to services/fastapi - Update README with new structure and confirmed tech stack - Update pad_scanner pointer to latest (.gitignore fix) - Add services/fastapi submodule Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
74 lines
1.6 KiB
Markdown
74 lines
1.6 KiB
Markdown
# CargoTrace - 库房货物追踪系统
|
||
|
||
## 项目概述
|
||
|
||
这是一个库房货物追踪管理系统的主仓库（Monorepo），采用 Git Submodule 的方式管理多个子项目。
|
||
|
||
## 子仓库
|
||
|
||
### Android 端 (Flutter)
|
||
- **路径**: `apps/pad_scanner`
|
||
- **仓库**: `git@gitea.server10086.icu:admin/pad_scanner.git`
|
||
- **技术栈**: Flutter
|
||
- **说明**: 基于 Flutter 框架的安卓应用，用于货物扫描和追踪
|
||
|
||
### 后端服务 (FastAPI)
|
||
- **路径**: `services/fastapi`
|
||
- **仓库**: `git@gitea.server10086.icu:CargoTrace/fastAPI.git`
|
||
- **技术栈**: FastAPI (Python)
|
||
- **说明**: 后端 API 服务
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
CargoTrace/
|
||
├── apps/ # 应用层子模块
|
||
│ └── pad_scanner/ # Flutter Android 应用
|
||
├── services/ # 后端服务子模块
|
||
│ └── fastapi/ # FastAPI 后端服务
|
||
├── shared/ # 共享代码/库（待添加）
|
||
├── infra/ # 基础设施（待添加）
|
||
└── docs/ # 项目文档
|
||
```
|
||
|
||
## 开发指南
|
||
|
||
### 克隆仓库
|
||
|
||
```bash
|
||
# 克隆主仓库
|
||
git clone <repo-url> CargoTrace
|
||
cd CargoTrace
|
||
|
||
# 初始化并更新所有子模块
|
||
git submodule update --init --recursive
|
||
```
|
||
|
||
### 添加新的子模块
|
||
|
||
```bash
|
||
git submodule add <submodule-url> <path>
|
||
```
|
||
|
||
### 更新子模块
|
||
|
||
```bash
|
||
# 更新所有子模块到最新提交
|
||
git submodule update --remote
|
||
|
||
# 更新特定子模块
|
||
cd <submodule-path>
|
||
git pull origin main
|
||
```
|
||
|
||
## 技术栈
|
||
|
||
| 层级 | 技术栈 | 状态 |
|
||
|------|--------|------|
|
||
| Android 端 | Flutter | ✅ 确定 |
|
||
| 后端服务 | FastAPI (Python) | ✅ 确定 |
|
||
|
||
## 许可证
|
||
|
||
待定
|