summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2f5857
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# 策研 Strategy Lab
+
+研究标的、采集行情、编写 Python 策略并执行回测的内部研究项目。
+
+## 当前状态
+
+开发中,尚未通过完整产品验收。当前源码包含尚未部署的 ETF 数据源修复;源码 main 分支不代表线上版本。行情源可能不可用,跨来源成交量单位仍需核对,UI 与完整浏览器流程正在整改。不可据此声称策略盈利或数据完整。
+
+## 结构
+
+- `frontend/`:Svelte 5 + TypeScript、CodeMirror、ECharts。
+- `server/`:Rust API、账户权限、数据集及任务管理。
+- `worker/`:行情采集、标准化与 Backtrader 回测。
+- `tests/`:Python 测试;前端及后端另有各自测试。
+
+## 开发检查
+
+```sh
+python -m venv .venv
+.venv/bin/pip install -r requirements-worker.txt
+.venv/bin/python -m pytest tests/worker -q
+npm --prefix frontend ci
+npm --prefix frontend run check
+npm --prefix frontend test
+npm --prefix frontend run build
+cargo test --manifest-path server/Cargo.toml
+```
+
+运行服务需要独立配置与隔离执行环境。不要把生产数据库、账户凭据或 Docker 管理接口暴露给公开开发会话。
+
+## 协作
+
+源码托管在 https://git.somhairle.bid/strategy-lab.git/ 。开发使用独立工作副本及功能分支;每个工作副本仅一个写入会话。OpenHands 开发环境与 OpenCode 编码任务应遵循这一约束。合并前提交测试证据;上线前单独完成真实数据、浏览器流程、视觉和失败恢复验收。禁止自动将提交部署到生产。
+
+密钥、本地模型配置、数据库、行情缓存、构建产物、第三方技能副本和内部操作记录不纳入公开仓库。公开可读不构成对行情数据、第三方依赖或项目源码的额外再许可授权。