summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9d1bfbb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# fund-lab
+
+私人单用户模拟基金平台。当前仓库处于阶段 1 骨架和阶段 2a 纯 F# 账本切片阶段;尚未接入数据库、真实行情或真实下单。
+
+## 本地验证
+
+在仓库根目录运行:
+
+```sh
+dotnet test
+dotnet build FundLab.sln
+```
+
+只运行账本领域测试:
+
+```sh
+dotnet test tests/FundLab.Domain.Tests/FundLab.Domain.Tests.fsproj
+```
+
+构建前端:
+
+```sh
+cd src/FundLab.Web
+npm install
+npm run build
+```
+
+API 使用环境变量 `FUND_LAB_AUTH_TOKEN` 配置 Bearer token;仓库只提供 `.env.example`,不保存真实凭证。`/health` 可匿名访问,业务 API 需要 `Authorization: Bearer <token>`。
+
+运行时数据库、行情缓存、凭证和构建产物不应进入 Git。远端 Git 写入机制和准确 remote URL 尚未确认,因此当前只进行本地开发和验证。