Moon

Go backend platform for aide-family — monorepo of shared tooling and microservices

中文 · English

---

Table of Contents

• About
• Features
• Prerequisites
• Installation
• Quick Start
• Project Structure
• Documentation
• Contributing
• License
• Acknowledgments

---

About

Moon is a Go backend platform maintained by aide-family. This repository is a monorepo that includes:

• A shared toolkit and library used by all applications
• Microservices built with Kratos and Cobra

Each application has its own go.mod, build pipeline, and documentation (English & 中文).

---

Features

• Monorepo — One repository for shared code and multiple services
• Kratos — Consistent service framework (HTTP/gRPC, config, logging)
• Cobra — CLI and subcommands for each app
• Magic Box — Shared utilities (safety, OAuth, validation, etc.) used across apps
• Bilingual docs — README and docs in English and 中文 for root and sub-projects

---

Prerequisites

• Go 1.25+
• Make

---

Installation

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

No global install is required at the repo root. Each app is built and run from its own directory (see Quick Start and Documentation).

---

Quick Start

From the repository root:

Build all apps:

make all

Run a single app in development mode:

make <app>

Where <app> is one of: goddess, rabbit, marksman. Example:

make rabbit

List all Make targets:

make help

Generate code (e.g. from protos) for all apps:

make gen

For app-specific setup (config, database, etc.), see the README of each app under Documentation.

---

Project Structure

Path	Name	Description
magicbox/	Magic Box (月光宝盒)	Shared toolkit and library (safety, OAuth, validation, etc.)
app/goddess/	Goddess (嫦娥)	Authentication and authorization service
app/rabbit/	Rabbit (玉兔)	Business service (e.g. time engine and related features)
app/marksman/	Marksman (后羿)	Event service
proto/	Protos	API definitions (e.g. goddess, rabbit)

• magicbox is a Go module; goddess, rabbit, and marksman depend on it via replace in their go.mod.
• Each app has its own go.mod, Makefile, and README (EN / 中文).

---

Documentation

Project	English	中文
Goddess	README	README
Rabbit	README	README
Marksman	README	README
Magic Box	README	README

---

Contributing

Contributions are welcome. Please:

1. Open an Issue for bugs or feature requests.
2. Fork the repo, create a branch, make your changes, and open a Pull Request.

Ensure code and style match the existing project conventions.

---

License

This project is under the MIT License. Each sub-project may have its own LICENSE file; see the following for details:

• app/goddess/LICENSE
• app/rabbit/LICENSE
• app/marksman/LICENSE
• magicbox/LICENSE

---

Acknowledgments

• Kratos — Go microservice framework
• Cobra — CLI library for Go