For AI agents: the complete documentation index is available at https://payhon.github.io/AppKernia/llms.txt, the full documentation bundle is available at https://payhon.github.io/AppKernia/llms-full.txt, and this page is available as Markdown at https://payhon.github.io/AppKernia/guide/index.md.

开始使用

第一次接触 AppKernia,不需要先理解所有蓝图。你可以先把完整系统跑起来,再按需要深入 Mobile、Admin 或 Server。

如果你还不确定它是否适合自己的项目,先读什么是 AppKernia?:那里介绍了项目为什么出现、名字的意义、技术选择、真实产品画面与未来方向。

你的目标推荐入口大约需要
只想最快看到完整系统Docker 一键运行Docker Desktop、Git
准备修改 Go 或 React 源码源码开发模式Go 1.26、Node 24、pnpm 11、Docker
开发 Android / iOS / HarmonyOS移动端开发HBuilderX 与目标平台工具链
先理解整个项目仓库结构5–10 分钟
先判断项目是否适合自己什么是 AppKernia?8–12 分钟
当前阶段AppKernia 尚未发布稳定版本。接口、迁移和组件 API 仍可能调整;用于生产前,请完成与你的部署环境和目标设备一致的安全、性能与平台验收。

第一次运行的成功判定

不要只以“命令没有报错”作为成功。完整的本机启动至少应满足:

  1. docker compose ps 中 PostgreSQL、API、Admin 的健康检查通过,Migration 与 Seed 以 0 退出。
  2. http://localhost:4173/healthz 返回成功,Admin 登录页可以加载且浏览器控制台没有阻断性错误。
  3. 使用你自己通过 bootstrap-admin 创建的本机账号登录;仓库不会提供固定默认密码。
  4. Dashboard 的摘要和趋势请求完成,而不是一直停留在 Skeleton 或错误态。
  5. 只有在目标平台真实编译、安装或运行后,才把 Mobile 对应平台记为通过。

如果任何一项不满足,先进入故障排查,保留首个失败命令和退出码,不要从后续连锁错误反推原因。

运行之后怎么继续

你准备做的事下一步
新增业务 API先读服务端约定与 OpenAPI 事实源
新增后台页面先确认权限、菜单、API Client 和双语键
新增 App 页面或组件进入移动端开发与 AK UI 文档
调整认证、权限或多租户边界先读认证与权限职责
准备提交改动贡献指南完成验证与证据

推荐阅读顺序

  1. 从源码仓库运行
  2. 什么是 AppKernia?
  3. 总体架构
  4. 认证与会话
  5. 服务端 API
  6. 移动组件
  7. 参与贡献