Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
huerni committed Dec 21, 2023
1 parent e160d64 commit c829ed2
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# gmitex
A Go microservices framework
<div align="center">
<h1>gmitex</h1>
</div>

gmitex is a lightweight microservices framework designed for individuals to quickly learn and develop microservices. Each microservice is configured with both RPC and RESTful interfaces and exposed to the outside world through a gateway. It supports dynamic addition of routes without the need for redundant definition of API files.
<div align="center">
<b>A Go microservices framework</b>
</div>

<div align="center">
<img src="https://img.shields.io/badge/Golang-1.20-orange"/>
<img src="https://img.shields.io/badge/Etcd-latest-green"/>
<img src="https://img.shields.io/badge/MySQL-8.0-yellowgreen"/>
<img src="https://img.shields.io/badge/Docker-24.0.6-blue"/>
</div>

**The purpose of this project is for personal learning and building purposes. Currently, it is at the demo level, with plenty of areas that can be modified and improved.**
gmitex is a lightweight microservices framework designed for individuals to quickly learn and develop microservices. Each microservice is configured with both RPC and RESTful interfaces and exposed to the outside world through a gateway. It supports dynamic addition of routes without the need for redundant definition of API files.

## Env
go 1.20
docker 24.0
>**The purpose of this project is for personal learning and building purposes. Currently, it is at the demo level, with plenty of areas that can be modified and improved.**
# Install
```shell
Expand All @@ -18,10 +26,11 @@ go install github.com/huerni/gmitex/gmctl@latest
```shell
#env check
gmctl check
mkdir <ProjectDir>

# Code generation
gmctl gateway
gmctl new <serverName>
gmctl new <ServerName>

#cd gateway
docker-compose up -d
Expand All @@ -33,14 +42,4 @@ go mod tidy
go run cmd/main.go
```

## 使用jwt
```shell
# 在需要认证的路径上标注:auth
// :auth
rpc Ping(PingReq) returns (PingResp) {
option (google.api.http) = {
get: "/api/v1/ping"
};
};
```

0 comments on commit c829ed2

Please sign in to comment.