Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudwego/biz-demo

Business Demo for CloudWeGo
https://github.com/cloudwego/biz-demo

demo go

Last synced: 4 days ago
JSON representation

Business Demo for CloudWeGo

Awesome Lists containing this project

README 

        
# CloudWeGo Demo for Business



This repo contains CloudWeGo demos with business logic, providing valuable references for enterprise user using in production.



Each demo should/may contain multiple CloudWeGo subprojects, e.g. Kitex & Hertz, and demonstrate an individual business scenario.



## Demo List



### 1. Bookinfo



#### Description

##### What is it about and what problem does it solve?

- How to use kitex proxyless in istio?

- How to implement full-process traffic lane using CloudWeGo?



##### What is the business scenario?

Rewrite **[Bookinfo](https://istio.io/latest/docs/examples/bookinfo/)** project using `hertz`, `kitex`, same as the **[Bookinfo](https://istio.io/latest/docs/examples/bookinfo/)**



> The application displays information about a book, similar to a single catalog entry of an online book store. Displayed on the page is a description of the book, book details (ISBN, number of pages, and so on), and a few book reviews.



The Bookinfo application is broken into four separate microservices:



- **productpage**. The productpage microservice calls the details and reviews **microservices** to populate the page.

- **details**. The details microservice contains book information.

- **reviews**. The reviews microservice contains book reviews. It also calls the ratings microservice.

- **ratings**. The ratings microservice contains book ranking information that accompanies a book review.



##### What are the core technologies/projects used?



- [x] Use `istiod` as xDS server for CRD configuration and distribution

- [x] Use `wire` for dependency injection

- [x] Use `opentelemetry` for tracing

- [x] Implement proxyless `flow lane` with [`Kitex-xds`](https://github.com/kitex-contrib/xds) and `opentelemetry baggage`

- [x] Implement a bookinfo ui using `arco-design` react



##### Which CloudWeGo subprojects are used? List all technologies used.

- [Kitex](https://github.com/cloudwego/kitex)

- [Hertz](https://github.com/cloudwego/hertz)

- [kitex-xds](https://github.com/kitex-contrib/xds)

- [kitex-opentelemetry](https://github.com/kitex-contrib/obs-opentelemetry)

- [hertz-opentelemetry](https://github.com/hertz-contrib/obs-opentelemetry)



##### Detailed documentation

[bookinfo](./bookinfo/README.md)



#### Contributors & Maintainers

[@CoderPoet](https://github.com/CoderPoet)



### 2. Open Payment Platform



#### Description

##### What is it about and what problem does it solve?

- How to use kitex generic call as the http gateway?

- How to implement Clean Structure of `Go` using kitex?



##### What is the business scenario?

> The application demonstrates the usage of kitex generic call.



- We build the `generic call` client for each backend server by traversing IDL in Hertz.

- Hertz will accept the requests with the query path of prefix `/gateway` .

- `Gateway` handler will process these requests and route them to backend server by `generic call` client.

- `payment` server is just a sample server using kitex.This service design pkg with `Clean Structure`.



##### What are the core technologies/projects used?



- [x] Use `Hertz` as Gateway.

- [x] Use `Kitex` generic call client route requests.

- [x] Use `Kitex` as RPC framework to build micro-services.

- [x] Use `Clean Architecture` for design pkg and code layout.

- [x] Use `ent` entity framework for implementing repository.

- [x] Use `wire` for dependency injection

- [x] Use `Nacos` as service registry.

- [x] Use `MySQL` as RDBMS.



##### Which CloudWeGo subprojects are used? List all technologies used.

- [Kitex](https://github.com/cloudwego/kitex)

- [Hertz](https://github.com/cloudwego/hertz)

- kitex-layout(coming soon)



##### Detailed documentation

[Open Payment Platform](./open-payment-platform/README.md)



#### Contributors & Maintainers

[@baiyutang](https://github.com/baiyutang)



### 3. Easy Note



#### Description

##### What is it about and what problem does it solve?

- How to get started with Hertz and Kitex collaboration?

- How to structure projects when using Hertz and Kitex?



##### What is the business scenario?

Migrate **[easy_note](https://github.com/cloudwego/kitex-examples/tree/main/bizdemo/easy_note)** and optimize the project.



> The application shows a note service that allows users to create, delete, update, and query notes.



The easy_note application is divided into three microservices:



- **demoapi** is an HTTP service that handles HTTP requests and calls other services via RPC.

- **demouser** is an RPC service that handles user related operations.

- **demonote** is an RPC service that handles note related operations and calls demouser service via RPC.



##### What are the core technologies/projects used?



- [x] Use `hz` and `kitex` to generate code

- [x] Use Hertz `requestid`, `jwt`, `pprof`, `gzip` middlewares

- [x] Use `go-tagexpr` and `thrift-gen-validator` for validating HTTP and RPC request

- [x] Use `obs-opentelemetry` for tracing

- [x] Use `etcd` as service registry.

- [x] Use `GORM` for implementing repository.

- [x] Use `MySQL` as RDBMS.



##### Which CloudWeGo subprojects are used? List all technologies used.

- [Hertz](https://github.com/cloudwego/hertz)

  - [obs-opentelemetry](https://github.com/hertz-contrib/obs-opentelemetry)

  - [requestid](https://github.com/hertz-contrib/requestid)

  - [jwt](https://github.com/hertz-contrib/jwt)

  - [pprof](https://github.com/hertz-contrib/pprof)

  - [gzip](https://github.com/hertz-contrib/gzip)

- [Kitex](https://github.com/cloudwego/kitex)

  - [obs-opentelemetry](https://github.com/kitex-contrib/obs-opentelemetry)

  - [registry-etcd](https://github.com/kitex-contrib/registry-etcd)

- [thrift-gen-validator](https://github.com/cloudwego/thrift-gen-validator)



##### Detailed documentation

[easy_note](./easy_note/README.md)



#### Contributors & Maintainers

- [@justlorain](https://github.com/justlorain)

- [@li-jin-gou](https://github.com/li-jin-gou)



### 4. Book Shop



#### Description

##### What is it about and what problem does it solve?

- How to integrate middlewares(such as `ElasticSearch`, `Redis`...) in Kitex project?

- How to layer code in projects of different complexity using Hertz and Kitex?



##### What is the business scenario?

> The application shows an e-commerce system that includes merchants managing items, consumers managing personal accounts and placing orders to buy items.



The book-shop application is divided into four microservices:



- **facade** is an HTTP service that handles HTTP requests and calls other services via RPC.

- **user** is an RPC service that handles user managements.

- **item** is an RPC service that handles item managements.

- **order** is an RPC service that handles order managements.



##### What are the core technologies/projects used?



- [x] Use `Hertz` as Gateway.

- [x] Use `Kitex` as RPC framework to build microservices.

- [x] Use Hertz `swagger`, `jwt`, `pprof`, `gzip` middlewares.

- [x] Use `ETCD` as service registry.

- [x] Use `MySQL` as RDBMS.

- [x] Use `Redis` as cache.

- [x] Use `ElasticSearch` as search-engine.



##### Which CloudWeGo subprojects are used? List all technologies used.



- [Hertz](https://github.com/cloudwego/hertz)

  - [swagger](http://github.com/hertz-contrib/swagger)

  - [jwt](http://github.com/hertz-contrib/jwt)

  - [pprof](https://github.com/hertz-contrib/pprof)

  - [gzip](https://github.com/hertz-contrib/gzip)

- [Kitex](https://github.com/cloudwego/kitex)

  - [registry-etcd](https://github.com/kitex-contrib/registry-etcd)

- [sonic](https://github.com/bytedance/sonic)



##### Detailed documentation

[Book Shop](./book-shop/README.md)



#### Contributors & Maintainers

[@bodhisatan](https://github.com/bodhisatan)



### 5. [FreeCar](https://github.com/CyanAsterisk/FreeCar)



#### Description

##### What is it about and what problem does it solve?

- How to use the idea of domain-driven development to develop in Kitex?

- How to develop Hertz and Kitex through RPC + AGW mode?



##### What is the business scenario?

>Time-sharing car rental system kit in the cloud-native era.



The FreeCar application is divided into six microservices:



- **api** is an HTTP service that handles HTTP requests and calls other services via RPC.

- **user** is an RPC service that handles user related operations.

- **profile** is an RPC service that handles profile related operations.

- **blob** is an RPC service that handles blob related operations.

- **car** is an RPC service that handles car related operations.

- **trip** is an RPC service that handles trip related operations.



##### What are the core technologies/projects used?



- [x] Use `hz` and `kitex` to generate code

- [x] Use Hertz `paseto`, `cors`, `gzip`, `http2`, `limiter`, `opensergo`, `pprof`, `websocket` middlewares

- [x] Use `obs-opentelemetry` for tracing

- [x] Use `consul` as service registry and config center.

- [x] Use `GORM` for implementing repository.

- [x] Use `MySQL` as RDBMS.

- [x] Use `MongoDB` as DOCDB.

- [x] Use `Redis` as cache.

- [x] Use `MinIO` as object storage center.

- [x] Use `RabbitMQ` as MQ.

- [x] Implement a [FreeCar-Admin](https://github.com/CyanAsterisk/FreeCar-Admin) using `arco-design` react.

- [x] Implement a [FreeCar-MP](https://github.com/CyanAsterisk/FreeCar-MP) using WeChat applet.



##### Which CloudWeGo subprojects are used? List all technologies used.

- [Hertz](https://github.com/cloudwego/hertz)

  - [obs-opentelemetry](https://github.com/hertz-contrib/obs-opentelemetry)

  - [registry](https://github.com/hertz-contrib/registry)

  - [paseto](https://github.com/hertz-contrib/paseto)

  - [cors](https://github.com/hertz-contrib/cors)

  - [pprof](https://github.com/hertz-contrib/pprof)

  - [gzip](https://github.com/hertz-contrib/gzip)

  - [http2](https://github.com/hertz-contrib/http2)

  - [limiter](https://github.com/hertz-contrib/limiter)

  - [opensergo](https://github.com/hertz-contrib/opensergo)

  - [websocket](https://github.com/hertz-contrib/websocket)

- [Kitex](https://github.com/cloudwego/kitex)

  - [obs-opentelemetry](https://github.com/kitex-contrib/obs-opentelemetry)

  - [registry-consul](https://github.com/kitex-contrib/registry-consul)



##### Detailed documentation

[FreeCar](https://github.com/CyanAsterisk/FreeCar/blob/dev/README.md)



#### Contributors & Maintainers

- [@L2ncE](https://github.com/L2ncE)

- [@Claude-Zq](https://github.com/Claude-Zq)