init
This commit is contained in:
70
docs/PROJECT_OVERVIEW.md
Normal file
70
docs/PROJECT_OVERVIEW.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# 项目说明(当前仓库)
|
||||
|
||||
## 项目定位
|
||||
- 本仓库提供 App 端后端 API 与 RN 客户端基础工程。
|
||||
- 后台管理系统将单独开发,不在本仓库实现前端。
|
||||
|
||||
## 仓库结构
|
||||
- `backend/`:Flask API 服务
|
||||
- `WA/`:React Native Expo 客户端工程
|
||||
- `wechat_end/`:已弃用小程序代码,仅存档
|
||||
- `app_end/`、`web_end/`:当前为空壳或未启用
|
||||
- `docx/`:产品与开发文档
|
||||
|
||||
## 后端概览
|
||||
### 技术栈
|
||||
- Flask 2.3.x
|
||||
- Flask-JWT-Extended
|
||||
- Flask-SQLAlchemy
|
||||
- Flask-CORS
|
||||
|
||||
### 入口与路由
|
||||
- 入口:`backend/app.py`
|
||||
- 路由:`backend/routes/*`
|
||||
- 模型:`backend/models/*`
|
||||
- 工具:`backend/utils/*`
|
||||
|
||||
### 主要模块
|
||||
- 认证:手机验证码登录、密码登录、设置密码、更新昵称
|
||||
- 宝宝:CRUD
|
||||
- 成长记录:CRUD
|
||||
- 预约:CRUD
|
||||
- 内容:视频/文章列表与详情(只读)
|
||||
- 聊天:转发 n8n,历史记录管理
|
||||
|
||||
## 前端概览(WA)
|
||||
- React Native Expo + TypeScript
|
||||
- 已落地通用 UI 组件、主题体系、Axios 封装、导航与状态管理
|
||||
- 详细进度参见 `docx/REFACTOR_PLAN.md` 与 `docx/FRAMEWORK_SETUP.md`
|
||||
|
||||
## 环境变量
|
||||
后端必要配置:
|
||||
- `DATABASE_URL`
|
||||
- `SECRET_KEY`
|
||||
- `JWT_SECRET_KEY`
|
||||
可选配置:
|
||||
- `N8N_WEBHOOK_URL`
|
||||
- `WECHAT_APP_ID`
|
||||
- `WECHAT_APP_SECRET`
|
||||
- `CONTENT_SEED`(设置为 1 时注入本地示例内容)
|
||||
|
||||
## 本地运行
|
||||
### 后端
|
||||
```
|
||||
cd backend
|
||||
python app.py
|
||||
```
|
||||
默认端口:`http://localhost:5010`
|
||||
|
||||
### 客户端(WA)
|
||||
```
|
||||
cd WA
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
## 约束与限制
|
||||
- 当前无管理员权限与跨用户管理接口。
|
||||
- 内容模块仅支持读取,不支持新增/编辑/删除。
|
||||
- 未配置软删除与审计日志。
|
||||
- 聊天模块依赖 n8n webhook,未配置时会返回错误。
|
||||
Reference in New Issue
Block a user