Skip to content

tytsxai/lab-starnode

Repository files navigation

StarNode(星诺)

让记录知识,变成亲眼看见思想演化的过程。

StarNode 是一个 本地优先(Local-first) 的知识管理实验项目: 你写下的每条笔记都会成为“宇宙中的一个知识粒子”,按星球聚合、按语义引力连接、按时间持续演化。

如果你厌倦了「写了很多、回头找不到、知识结构看不见」的笔记体验,这个项目是为你准备的。


✨ 项目亮点

  • 写作优先:先保证输入与编辑体验,再谈炫酷可视化。
  • 本地优先:默认浏览器本地存储,断网可读写。
  • 可解释关联:不仅告诉你“这两条笔记有关”,还会展示触发证据(标签/关键词/评分)。
  • 3D 宇宙视图:以空间化方式探索自己的知识版图。
  • 工程化质量门禁:lint / test / typecheck / build 一键验证。

🧱 当前能力(MVP)

  • 笔记创建、编辑、删除、撤销
  • 星球分类管理(含批量迁移)
  • 冰封/解冻机制(可控制是否纳入统计与关联)
  • 标签与关键词关联线
  • 证据可解释关联面板
  • 本地持久化 + 基础迁移 + 跨标签页同步
  • 健康探针接口:/api/health

🏗️ 仓库结构(Monorepo)

.
├─ apps/
│  └─ web/                 # Next.js 应用壳层(交互与页面)
├─ packages/
│  ├─ core/                # 领域模型与关联算法(纯逻辑)
│  ├─ renderer/            # 3D 渲染组件
│  └─ storage/             # 本地持久化与迁移
├─ docs/
│  └─ 生产运维手册.md       # 发布、回滚、观测、备份恢复
├─ scripts/
│  ├─ check-build-safety.mjs
│  ├─ check-node-version.mjs
│  └─ smoke-prod-web.mjs
└─ package.json

模块依赖关系

apps/web
  -> @starnode/core
  -> @starnode/renderer
  -> @starnode/storage

🚀 快速开始

1) 环境要求

  • Node.js: 22.x
  • npm: 建议使用 Node 22 自带 npm(避免版本漂移)

项目包含 Node 版本门禁;并在 CI/托管构建启用 Build Safety Gate,禁止 STARNODE_ALLOW_UNSAFE_BUILD=1 进入发布链路。

2) 安装依赖

npm ci

3) 启动开发环境

npm run dev

打开浏览器访问:

  • http://localhost:3000

4) 运行质量门禁

npm run ci:verify

该命令会依次执行:

  • lint
  • test
  • typecheck
  • build

🧪 常用命令

# 根仓库
npm run dev              # 启动 web 开发环境
npm run build            # 构建所有 workspace
npm run lint             # 运行 lint
npm run test             # 运行测试
npm run typecheck        # 运行类型检查
npm run ci:verify        # 一键质量门禁

# 生产 smoke(先 build 再启动并探测健康接口与安全头)
npm run smoke:prod:web

🔍 健康检查与发布前验证

  • 健康探针:GET /api/healthHEAD 同样可用)
  • 预期返回:HTTP 200,{ status: "ok", ... }

建议在发布前执行:

npm ci
npm run ci:verify
npm run smoke:prod:web
npm audit --omit=dev

更多生产流程见:docs/生产运维手册.md


💾 数据与隐私说明

当前版本为本地优先,核心数据存储于浏览器 localStorage

  • 默认 key:starnode:notes
  • 适合个人知识宇宙场景
  • 若清理浏览器本地数据,未备份内容会丢失

备份与恢复流程见:docs/生产运维手册.md


🗺️ 文档导航


🤝 参与贡献

欢迎 Issue / PR。建议先阅读 CONTRIBUTING.md


📌 项目状态

当前仓库聚焦于 MVP 与工程质量稳定性: 先把“可用、可解释、可维护”打牢,再推进更大规模的 AI 与协作能力。

Packages

 
 
 

Contributors