sanchin

README

SANCHIN: Governance-oriented Microservice Framework

Introduction

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

Online Demo

Sanchin Console (Yiqi)

Username: admin
Password: admin

Documentation

See the 中文文档 for the Chinese documentation.

Requirements

• Go version >= 1.19
• Docker

Quick Start

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

go install gitee.com/chanuei/sanchin/cmd/sanchin@latest
sanchin new example-go
cd example-go
go mod tidy
docker-compose -f test/docker-compose.yml up -d
sanchin run -c cmd/exampleserver/.sanchin.toml

Learn More:

• Yiqi: Microservice Governance System for sanchin
• Sanchin Layout: Project Template for sanchin
• 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

Documentation

Index

• Variables
• type Application
• type Disable
• type Option

Variables

var (
	//StageAfterStop after app stop
	StageAfterStop uint32 = uint32(hooks.Stage_AfterStop)
	//StageBeforeStop before app stop
	StageBeforeStop = uint32(hooks.Stage_BeforeStop)
)

var DefaultApp = application.DefaultApp

var New = application.New

var WithConfigParser = application.WithConfigParser

var WithDisable = application.WithDisable

Types

type Application

type Application = application.Application

Application is the framework's instance, it contains the servers, workers, client and configuration settings. Create an instance of Application, by using &Application{}

type Disable

type Disable = application.Disable

const (
	DisableParserFlag      Disable = application.DisableParserFlag
	DisableLoadConfig      Disable = application.DisableLoadConfig
	DisableDefaultGovernor Disable = application.DisableDefaultGovernor
)

type Option

type Option = application.Option