Skip to content

Repository files navigation

Coral

GitHub stars License: MIT Platform PRs Welcome

Stable Assets, Replaceable Runtime(资产稳定,运行时可替换)

一个完全属于个人的、可持续成长进化的 第二大脑 平台——把孩子的学习画像、错题、知识沉淀为受 Git 管理的私有资产,再由可热拔插的场景化 Skill 实时驱动。

🇨🇳 中文用户:GitHub(主仓库) | Gitee 镜像(国内访问快)


⭐ 如果这个项目对你有用,点个 Star 是最大的支持——让更多家长看到它。

💬 有想法?来 Discussions 聊 · 🎯 想要新学科?提个 Skill 需求 · 📋 看路线图

✨ 它解决什么问题

痛点 Coral 的做法
AI 直接给答案,孩子变懒 苏格拉底式引导——不给答案,反问引导孩子自己思考
错题本全靠手抄,坚持不下来 自动错题归档——对话中标记错题,自动按学科/原因分类入库
学习数据被 App 锁死,换工具就没了 Git 资产永续——所有数据存本地 + Git 同步,10 年后仍可读
换个年级/学科就要换 App 学科 Skill 热插拔——加一个文件夹就能加一门学科,不改代码
AI 厂商倒闭了数据怎么办 运行时可换芯——今天用豆包,明天换 Kimi,数据一分不动
怕后门、怕收费跑路 完全开源 MIT——自己能审计,免费版永远可用

📱 下载

Android APK(v0.2.0,约 27MB)

下载渠道 链接 说明
GitHub Release 下载 推荐,海外/可访问 GitHub 用户
Gitee 镜像 下载 国内访问更快

iOS / 应用商店上架规划中。Pro 托管版(免填 Key)即将推出。

🚀 快速开始(手机端)

  1. 下载上方 APK 安装
  2. 打开 App → 设置页填入你的 LLM API 地址、Key、模型名
    • 推荐免费起步:智谱 GLM(glm-4.6v-flash,免费组,支持多模态)
    • 或任何 OpenAI 兼容端点(方舟/Kimi/OpenAI 等)
  3. 聊天页输入 / 唤起学科助手,开始对话
  4. 拍照发送错题,AI 引导思考 + 自动归档错题本
  5. 同步页填入 Git 仓库地址,数据永久留存

🧩 内置学科 Skill

Skill 命令 说明
数学老师 /math 苏格拉底式引导,不给答案只引导思考
语文老师 /chinese 字词句篇,阅读理解
英语老师 /english 语法、词汇、口语
作文辅导 /essay 20 问引导法,从零开始写作文 + 批改

加一门学科 = 在 .agents/skills/ 下加一个文件夹,热更新生效。


💡 需求与反馈

你的需求直接决定开发优先级。 不用写代码,花 30 秒提个 Issue 就行:

你想要… 去哪里
🎯 新学科 Skill(物理 / 化学 / 编程 / …) 提 Skill 需求
✨ 功能改进 / 新功能 提功能建议
🐛 遇到 Bug 提 Bug 反馈
💬 随便聊聊 / 使用心得 / 晒娃 Discussions 讨论区
📋 看看接下来做什么 Roadmap 路线图

开源项目靠社区驱动。你的每一条反馈都在帮 Coral 长大。

为什么叫 Coral

Coral(珊瑚)是项目宪法的生物化具象——不是装饰性比喻,而是「稳定资产 + 可替换运行时」在自然界里的对应物:

  • 礁石 = 稳定资产:珊瑚虫一代代死去(运行时随时可替换),礁石却永久留存并持续生长。这正是「资产永续、不随某个 AI 厂商存亡而消失」。
  • 珊瑚虫 = 可热拔插的 Skill / Runtime:活的、可替换的层;今天用 Agno,明天换 PydanticAI,业务代码零改动。
  • 持续生长 + 沉淀积累:每一次学习纠错都像新长出的一层,沉淀为受 Git 管理的私有资产,对应「可持续成长进化」。
  • 微型生态系统:一个完全属于个人的、自我演进的知识生态。

所以 Coral 不是「第二大脑」的替代词,而是它的成长形态——会生长、可换芯、永留存。

架构概览

[ Open WebUI ] ──v1/chat/completions──▶ [ coral.api ]
                                          [ coral.domain ] ◄── 纯业务核心,零 AI 框架依赖
                                          [ coral.runtime.adapter ] ──▶ agno / pydanticai / langgraph
                                          [ coral.infrastructure ] ──▶ L1-L4 内存 fake / SQLite / PG / pgvector

分层原则:依赖方向永远向内(API → Domain ← Infrastructure)。Domain 是最内圈。

快速开始

1. 安装依赖

# 安装包 + 开发依赖(需要可访问 PyPI)
pip install --no-build-isolation -e ".[dev]"

# (可选)安装 Agno 运行时
pip install -e ".[agno]"

2. 运行测试

pytest

3. 启动后端(开发模式)

# 需要 Agno 运行时 + API Key
uvicorn coral.api.main:app --host 0.0.0.0 --port 8000

然后访问 http://localhost:8000/healthz 确认健康。

4. Docker 一键拉起(完整栈)

# 设置 API Key(必填,见 docker/.env.example)
export CORAL_LLM_API_KEY=your-key-here

# 启动后端服务
docker compose --env-file docker/.env -f docker/docker-compose.yml up --build -d

服务说明:

服务 端口 说明
coral-frontend 3000 Open WebUI(移动端前端)
coral-backend 8000 Coral 后端 API(OpenAI 兼容网关)
coral-watcher — Skill 资产热重载监听
coral-db 5432 PostgreSQL + pgvector

5. 热更新 Skill(不重启)

修改 .agents/skills/ 下的 manifest.json 或 system.md,watcher 自动检测变更 并 POST 到 /api/reload,运行时立即生效。

也可以手动触发:

curl -X POST http://localhost:8000/api/reload

6. 手机端构建

.\mobile\build_apk.bat

项目结构

详见 docs/02-project-tree.md,核心概览:

.agents/               # 全局资产层(Git 管理,与运行时解耦)
  skills/              # 场景化 Skill 插件
  prompts/             # 通用公共 Prompt
  knowledge_assets/    # 多模态知识沉淀
backend/src/coral/
  api/                 # OpenAI 兼容网关 + 热重载 + 健康检查
  domain/              # 纯业务核心(Skills / Memory / Events)
  runtime/adapter/     # AI 运行时适配器(agno + 预留槽位)
  infrastructure/      # 存储实现(v1: 内存 fake)
docker/                # 容器化部署
docs/                  # 5 份施工设计文档

设计文档

文档 说明
00-product.md 产品设计细化
01-architecture.md 核心架构规约(DDD + Adapter + Event)
02-project-tree.md 统一目录树
03-skills-spec.md 热拔插 Skill 规范
05-ai-development-guide.md AI 开发军规
06-export-contract.md 知识 bundle 导出契约
ROADMAP.md 开发路线图
CONTRIBUTING.md 贡献指南

开发规范(宪法摘要)

  1. 资产独立:.agents/ 是圣地,代码中禁止魔法字符串提示词。
  2. 拒绝越权:Skill 不直接碰数据库,副作用走 Event Bus。
  3. 依赖倒置:coral.domain 禁止 import 任何 AI 框架(由架构守护测试自动检查)。
  4. 单步 TDD:先写失败测试,再写实现。
  5. 零状态热更新:修改 Skill 资产,Runtime 不重启、用户不中断。

🤝 社区

许可证

MIT --完全开源,自己能审计,免费版永远可用。

About

Coral - open-source AI tutor app for kids | Socratic guidance, auto mistake book, Git-backed assets, hot-swappable subject skills

Topics

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages