tibuild

README

TiBuild

This repository is a build platform for PingCAP, Welcome bros!

Design

click and jump

Technologies

• Backend: Golang & Gin
• Database: Mysql of Gorm
• Common Utils: Github & Config
• Deployments: Docker & Kubernetes
• Frontend: Create-React-App for framework & Material-UI/MUI for components & Axios for remote procedure call

Quick Start

git clone https://github.com/PingCAP-QE/ee-apps.git
cd ee-apps/tibuild/
# create a config.yaml in root path (detail like /tibuild/config_example.yaml)
make run

After waiting a few seconds, application is available and can be visited in the browser:localhost:8080

File Structure

tibuild
├── .gitignore
├── README.md
├── go.mod             # Golang environment configuration
├── go.sum
├── config.yaml        # Global configuration
├── Makefile           # Code compilation and other instructions
└── scripts/           # Scripts to perform various operations, keep the root level Makefile small and simple
└── cmd/               # Main application starters of Golang
└── api/               # REST API registry & Static file router, reference: https://github.com/gin-gonic/gin
    ├── api.go
└── deployments/
    └── docker/        # Build docker image contains website and server binary
    └── kubernetes/    # Deployment yaml for k8s
└── commons/           # Common utils for whole project
    └── configs/       # Global configuration reader
    └── database/      # Database connectors
    └── httpclient/    # Http client utils
└── internal/          # Business code & function
    └── entity/        # Object entity
    └── service/       # Service for controller/
    └── controller/    # Deal with http request
    └── dto/           # Output struct(no database)
└── website/           # UI components and pages. detail can jump to  website/README.MD
    ├── yarn.lock      # React environment configuration for machines
    ├── package.json   # React environment configuration for people
    └── src/           # index.js & routes.js/ Components/ Pages/ ...
    └── public/        # HomePage: index.html and icons