https://github.com/ozline/tiktok
[Rank. 3rd] Kitex + Hertz + Prometheus + Grafana + RabbitMQ + Redis + Gorm + etcd + es + Kibana. Distributed and relatively standardized backend for short video engineering.
https://github.com/ozline/tiktok
docker docker-compose elasticsearch etcd golang gorm grafana hertz kibana kitex microservice mysql prometheus rabbitmq thrift
Last synced: 25 days ago
JSON representation
[Rank. 3rd] Kitex + Hertz + Prometheus + Grafana + RabbitMQ + Redis + Gorm + etcd + es + Kibana. Distributed and relatively standardized backend for short video engineering.
- Host: GitHub
- URL: https://github.com/ozline/tiktok
- Owner: ozline
- License: mit
- Archived: true
- Created: 2023-01-29T22:16:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-13T07:44:58.000Z (4 months ago)
- Last Synced: 2025-02-19T17:17:10.136Z (2 months ago)
- Topics: docker, docker-compose, elasticsearch, etcd, golang, gorm, grafana, hertz, kibana, kitex, microservice, mysql, prometheus, rabbitmq, thrift
- Language: Go
- Homepage:
- Size: 31.5 MB
- Stars: 69
- Watchers: 1
- Forks: 20
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> **INFO: This project has ended development in December 2023 and has entered the Archived state. We have done a more "software engineering" project based on this project, [west2-online/fzuhelper-server](https://github.com/west2-online/fzuhelper-server). It is used by real users (teachers and students in the whole school), and it is more refreshing and elegant, please refer to it.**
# tiktok
English | [简体中文](./docs/zh-cn.md)
**tiktok** is a distributed **simple-tiktok** backend based on RPC and HTTP protocols using Kitex + Hertz + etcd + MySQL + Jaeger + Docker + Thrift + Prometheus + Grafana + Elasticsearch + Kibana
# Materials (Simplified Chinese only)
This project is a part of a competition. We have attached our final materials here.
Quietly say: We have achieved a good ranking.
[Documentation](https://west2-online.feishu.cn/docx/Bk20dtIHYoqfDCxnKw6c6eeMnih)
[Replay of the defense](https://www.bilibili.com/video/BV1Ep4y1P7ZT)
# Feature
- Extremely easy to use and deploy.
- Relatively mature CI/CD.
- Relatively high code quality
- Safety Considerations
- Performance Optimization for Interfaces
# Architecture
# Quick start
We will introduce how to quickly start this project using Docker. If you need to build and run it locally, please refer to: [start-by-local](./docs/start-by-local.md)
Due to the script we have written, the process has been greatly simplified. You just need to use the following command to quickly start the environment and run the program in a containerized manner.
```bash
make env-up # launch environment, env-down for remove
make docker # build docker-image
sh docker-run.sh # launch all services
# if you just want to launch specific service, use
sh docker-run.sh api # or others
```
then you can send HTTP request on `localhost:10001` for test or others things
# Quick deploy
We use a fully automated process to streamline the workload, so you can always use our Docker image packaged with the latest code.
You can directly copy the `deploy` folder of our project to the server you expect to deploy. The folder structure is roughly as follows
```bash
deploy
├── config # same as this projects
│ ├── config.yaml
│ ├── words.txt # sensitive word list
│ ├── prometheus.yml
│ └── sql # for mysql init
│ ├── init.sql
│ └── user.sql
├── docker-compose.yml # for environment, same
└── restart-service.sh # deploy scripts
```
The script will automatically pull the latest image from Aliyun ACR, find and delete the running containers, and re-run them with the latest image.
If you want a specific tutorial on how to use it, please visit: [deploy docs](./deploy/README.md)
# Project structure
## Overall
```bash
.
├── Dockerfile
├── LICENSE
├── Makefile # some useful commands
├── README.md
├── cmd # microservices
├── config # for run-directly config and config-example
├── deploy # for deploy
├── docker-compose.ci.yml # for ci env
├── docker-compose.yml
├── docker-run.sh # for local docker-run
├── docs
├── go.mod
├── go.sum
├── idl # interface definition
├── kitex_gen
├── pkg
│ ├── constants # store any consts
│ ├── errno # custom error
│ ├── middleware # common middleware
│ ├── tracer # for jaeger
│ └── utils # useful funcs
└── test
```
## Gateway/api service
```bash
.
├── Makefile
├── biz
│ ├── handler # solve request/send response
│ ├── middleware
│ ├── model
│ ├── pack # pack response
│ ├── router # for route
│ └── rpc # send rpc request to microservices
├── build.sh
├── main.go
├── output # build binary
├── router.go
├── router_gen.go
└── script
```
## Microservices
```bash
.
├── Makefile # useful commands
├── build.sh # build binary
├── dal
│ ├── cache # redis
│ ├── db # MySQL
│ └── mq # RabbitMQ
├── handler.go
├── kitex_info.yaml
├── main.go
├── output # build binary
├── pack # pack response
├── rpc # send request to other services
├── script
├── coverage # coverage test(some service not exist)
└── service
```
# Test
you can drop `.postman/tiktok.openapi.json` to **postman** then start this project and test
# Visualization example
## Jaeger
## Kibana + Elasticsearch
## Grafana + Prometheus
# Contributor
Fuzhou University west2-online studio golang team
- [ozline](https://github.com/ozline)
- [XZ0730](https://github.com/XZ0730)
- [wushiling50](https://github.com/wushiling50)
- [jiuxia211](https://github.com/jiuxia211)
- [Ricky](https://github.com/Ricky-chen1)
- [jkskj](https://github.com/jkskj)