README.md

JUPITER: Governance-oriented Microservice Framework

Introduction

JUPITER is a governance-oriented microservice framework, which is being used for years at Douyu.

Documentation

See the 中文文档 for the Chinese documentation.

Requirements

• Go version >= 1.18
• Docker

Quick Start

1. Install jupiter toolkit
2. Create example project from jupiter-layout
3. Download go mod dependencies
4. Run the example project with jupiter toolkit
5. Just code yourself :-)

go install github.com/douyu/jupiter/cmd/jupiter@latest
jupiter new example-go
cd example-go
go mod tidy
docker-compose -f deployment/docker-compose.yml up -d
jupiter run -c cmd/exampleserver/.jupiter.toml

More Example:

• Project Layout
• Examples

Bugs and Feedback

For bug report, questions and discussions please submit an issue.

Contributing

Contributions are always welcomed! Please see CONTRIBUTING for detailed guidelines.

You can start with the issues labeled with good first issue.

Contact

• Wechat Group