Skip to content

README-zh_CN.md

Latest commit

 

History

History
161 lines (101 loc) · 4.47 KB

README-zh_CN.md

File metadata and controls

161 lines (101 loc) · 4.47 KB
Raw

Moon

aide-family 的 Go 后端平台 — 共享工具与微服务单仓库

中文 · English

目录

项目简介

Moon 是由 aide-family 维护的 Go 后端平台。本仓库采用 单仓库（monorepo） 结构，包含：

  • 供各应用共用的共享工具库
  • 基于 Kratos 与 Cobra 构建的微服务

每个应用拥有独立的 go.mod、构建流程及文档（英文与中文）。

特性

  • 单仓库 — 共享代码与多服务统一管理
  • Kratos — 统一的微服务框架（HTTP/gRPC、配置、日志等）
  • Cobra — 各应用的 CLI 与子命令
  • Magic Box — 跨应用共享的工具集（安全、OAuth、校验等）
  • 中英双语文档 — 根目录与子项目均提供英文与中文 README

环境要求

安装

git clone https://github.com/aide-family/moon.git
cd moon

根目录无需全局安装。各应用在其自身目录内完成构建与运行（见 快速开始 与 文档）。

快速开始

在仓库根目录执行：

构建所有应用：

make all

以开发模式运行单个应用：

make <应用名>

其中 <应用名> 可为：goddess、rabbit、marksman、jade_tree。示例：

make rabbit

查看所有 Make 目标：

make help

为所有应用生成代码（如基于 proto）：

make gen

各应用的配置、数据库等具体说明见 文档 中对应 README。

项目结构

路径 名称 说明
[magicbox/](magicbox/) Magic Box（月光宝盒） 共享工具库（安全、OAuth、校验等）
[app/goddess/](app/goddess/) Goddess（嫦娥） 认证与授权服务
[app/rabbit/](app/rabbit/) Rabbit（玉兔） 业务服务（如时间引擎及相关能力）
[app/marksman/](app/marksman/) Marksman（后羿） 事件服务
[app/jade_tree/](app/jade_tree/) Jade Tree（玉树） 采集与通信 Agent 运行时服务
[proto/](proto/) Protos API 定义（如 goddess、rabbit）
  • magicbox 为独立 Go 模块；goddess、rabbit、marksman 通过各自 go.mod 中的 replace 引用本地 magicbox。
  • 各应用拥有独立的 go.mod、Makefile 及 README（中/英）。

文档

项目 英文 中文
Goddess README README
Rabbit README README
Marksman README README
Jade Tree README README
Magic Box README README

参与贡献

欢迎贡献代码与文档。请：

  1. 通过 Issue 提交 Bug 或功能建议。
  2. Fork 本仓库，创建分支，完成修改后提交 Pull Request。

请保持与现有项目风格与约定一致。

许可证

本项目采用 MIT 许可证。各子项目可能拥有独立的 LICENSE 文件，详见：

致谢