# SwiftFlow

SwiftFlow 是一个基于 Monorepo（单仓库）架构的全端系统，后端采用 **Gleam** 开发，多端应用统一协同。

## 目录结构规划

```text
SwiftFlow/
├── backend/              # 后端服务（基于 Gleam，负责核心业务逻辑与 API 提供）
├── web/                  # Web 前端（基于 Vite 构建，支持 SPA / SSR）
├── miniapp/              # 小程序端（微信小程序 / Uni-app / Taro 等）
├── desktop/              # 客户端 / 桌面端（支持 macOS、Windows）
│   ├── macos/            # macOS 客户端配置/原生工程（或统一跨端如 Tauri）
│   └── windows/          # Windows 客户端配置/原生工程
├── mobile/               # APP 端（移动端，支持 iOS、Android）
│   ├── ios/              # iOS 工程（原生或跨端壳）
│   └── android/          # Android 工程（原生或跨端壳）
├── shared/               # 跨端共享层（协议定义、通用类型、通用工具库）
│   └── ql361api/         # 第三方/外部 API 对接或特定公共模块
└── docs/                 # 项目综合文档库
    ├── architecture/     # 架构设计与技术选型文档
    ├── api/              # API 接口规范与契约文档
    └── guides/           # 开发规范、环境搭建与部署指南
```

## 技术栈与端侧定位

| 端侧 | 目录 | 推荐/采用技术栈 | 说明 |
| :--- | :--- | :--- | :--- |
| **后端** | `backend/` | Gleam (Mist / Wisp / Bandit) | 强类型、函数式、高并发 BEAM 生态 |
| **Web端** | `web/` | Vite + React / Vue / Lustre | 现代化前端工程，负责桌面/移动浏览器访问 |
| **小程序端** | `miniapp/` | Uni-app / Taro / 微信原生 | 覆盖微信生态及国内小程序平台 |
| **客户端** | `desktop/` | Windows & macOS (建议 Tauri / Rust) | 性能高效、体积轻量，复用前端能力 |
| **APP端** | `mobile/` | iOS & Android (Flutter / React Native / Tauri Mobile) | 移动端原生体验 |
| **共享层** | `shared/` | OpenAPI / Gleam types / TS types | 跨端通信协议、接口类型定义 |
| **文档** | `docs/` | Markdown 文档体系 | 架构、API、开发指南 |

---

## 快速指引

- **文档中心**：查看 [`docs/README.md`](file:///Users/pluto/MyProject/NMProject/fosi.dev/SwiftFlow/docs/README.md)
- **后端开发**：请进入 [`backend/`](file:///Users/pluto/MyProject/NMProject/fosi.dev/SwiftFlow/backend)
- **Web 前端**：请进入 [`web/`](file:///Users/pluto/MyProject/NMProject/fosi.dev/SwiftFlow/web)