50 lines
2.4 KiB
Markdown
50 lines
2.4 KiB
Markdown
# FreeMoCap 源码解析
|
||
|
||
## 启动
|
||
- `python3 -m http.server 4720` — 端口 4720
|
||
|
||
## 环境一致性
|
||
- Web / API / 后台服务 / 全栈 App 项目必须以本地 Docker 为准：`docker compose up --build`
|
||
- 宿主机 `npm run dev` / `pnpm dev` / `python main.py` 只能作为临时开发辅助，不算交付验证
|
||
- 第一次形成可运行代码时，必须补齐 `Dockerfile`、`docker-compose.yml` 或等价 compose 文件、`.dockerignore`、`.env.example`
|
||
- 线上部署必须复用同一套 Docker 构建逻辑；`git push` 本身不等于线上容器更新
|
||
- 如果本项目属于静态研究页、纯文档、macOS / iOS 原生 App、GPU / GUI / 特殊硬件例外，必须在这里写清原因和实际运行环境
|
||
|
||
## 部署事实
|
||
- 平台：待定
|
||
- 发布状态：未部署
|
||
- 主站 / 前端：待定
|
||
- API / 后端：待定
|
||
- 文档 / 解析：待定
|
||
- 管理后台：待定
|
||
|
||
## 快捷登录
|
||
- 登录地址：待补充
|
||
- 用户名：待补充
|
||
- 密码：待补充
|
||
- 说明：这里只写项目专属网页登录；数据库密码、API Key、服务器 root 密码不要写这里
|
||
|
||
## 元数据回写清单
|
||
- 新增或变更公网地址后，必须同步更新 `.project.json.urls`
|
||
- 仓库内存在 App 源码或构建入口时，必须能在看板显示 `App` 标记；自动检测不准时，手动写 `.project.json.app_artifacts`
|
||
- 如果有网页后台登录：
|
||
- 可直接入库：写 `.project.json.quick_login`
|
||
- 不应入库：写 `.project.json.credentials` 引用
|
||
- 部署完成后，`RULES.md` 和 `.project.json` 必须同一次任务一起更新
|
||
|
||
## 环境变量
|
||
- `.env.example` 必须列出项目运行所需变量名
|
||
- 本地 `.env` 可作为部署运行时配置来源，但不得提交进 Git
|
||
- 部署时默认可以携带本地测试运行数据和密钥；助手只需先提醒风险，除非用户明确说“不带密钥 / 不带数据”
|
||
- 密钥只能进入服务器 env / Coolify 加密变量 / 运行时配置，不得写入 `.project.json.quick_login` 或聊天日志
|
||
|
||
## 规则
|
||
- 全项目规则真源：`/Users/kangwan/Projects/code/20260317-rules-dashboard/RULES.md`
|
||
- 版本发布规则：`/Users/kangwan/Projects/code/20260317-rules-dashboard/rules/04-版本发布规则.md`
|
||
- 不允许编造不存在的部署域名、账号、密码
|
||
- 没有公网地址时，`.project.json.urls` 保持空数组
|
||
- 任何部署或域名变化，都要先改元数据，再视为任务完成
|
||
|
||
## 注意事项
|
||
- 待补充
|