KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #deepseek-harness #typescript #ai-agent #codex #developer-tools #claude-code #windows #mcp #python #desktop-app

go-pangu

★ 47 Open GitHub ↗

rest api web server based on go(High availability, high security, high performance)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Golang-pangu
[中文文档](https://github.com/ruilisi/go-pangu/blob/master/READMECN.md)

Go-pangu is a Go boilerplate which follows cutting-edge solutions already adopted by the industry,  JWT(JSON Web Tokens), Postgres, Redis, Docker,  Gin, Ginkgo, Gorm. It is a solid production-ready starting point for your new backend projects.

## Features
Golang-pangu is based on following tools

|name|description|
|------|--------|
|[Go](https://github.com/golang/go)|an open source programming language that makes it easy to build simple, reliable, and efficient software.|
|[Gin](https://github.com/gin-gonic/gin)|web struct based on Go, flexible middleware，strong data binding and outstanding performance.|
|[Gorm](https://github.com/go-gorm/gorm)|The fantastic ORM library for Golang aims to be developer friendly.|
|[Ginkgo](https://github.com/onsi/ginkgo)|Ginkgo builds on Go's testing package, allowing expressive Behavior-Driven Development ("BDD") style tests.|
|[JWT](https://jwt.io/)|JSON Web Tokens. An open, industry standard RFC 7519 method for representing claims securely between two parties.|
|[Postgres](https://www.postgresql.org/)|The world's most advanced open source relational database|
|[Redis](https://redis.io/)|An open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.|
|[Docker](https://www.docker.com/)|Docker is a tool designed to make it easier to create, deploy, and run applications by using containers.|

## Struct
```
.
├── application.yml  
├── args
│   ├── args.go
│   └── cmd.go
├── conf  
│   ├── conf_debug.go
│   ├── conf.go
│   └── conf_release.go
├── controller
│   ├── application.go
│   ├── auth.go
│   ├── error.go
│   └── session.go
├── db  
│   └── db.go
├── Dockerfile
├── go.mod
├── go.sum
├── jwt  
│   └── jwt.go
├── main.go
├── Makefile  
├── middleware  
│   └── middleware.go
├── models  
│   ├── base_model.go
│   └── user.go
├── params  
│   └── params.go
├── README.md
├── redis
│   └── redis.go
├── routers  
│   └── router.go
├── test
│   ├── sign_in_test.go
│   └── test_suite_test.go
└── util
    └── util.go
```

|file|function|
|------|--------|
|application.yml|config file|
|[args](https://github.com/ruilisi/go-pangu/tree/master/args)|functions which can fetch params from request url|
|[conf](https://github.com/ruilisi/go-pangu/tree/master/conf)|functions which can get configurations|
|[controller](https://github.com/ruilisi/go-pangu/tree/master/controller)|handlers|
|[db](https://github.com/ruilisi/go-pangu/tree/master/db)|database operations like migrating database|
|[jwt](https://github.com/ruilisi/go-pangu/tree/master/jwt)|fuctions to create and check jwt|
|main.go|main function.Call function with "--db" parameter, "create" to create database, "migrate" to migrate tables, "dorp" to delete database|
|[middleware](https://github.com/ruilisi/go-pangu/tree/master/middleware)|middleware|
|[models](https://github.com/ruilisi/go-pangu/tree/master/models)|base models and basic database operations|
|[params](https://github.com/ruilisi/go-pangu/tree/master/params)|struct used in data binding|
|[redis](https://github.com/ruilisi/go-pangu/tree/master/redis)|redis connection and operations|
|[router](https://github.com/ruilisi/go-pangu/tree/master/routers)|router|
|[test](https://github.com/ruilisi/go-pangu/tree/master/test)|test|
|[i18n](https://github.com/ruilisi/go-pangu/tree/master/i18n)|internationalization|
|[influx](https://github.com/ruilisi/go-pangu/tree/master/influx)|influx operations include read/save point|

## Start

1. install postgres, redis
2. config application.yml
3.
```sh
`make create`(create database) or `go run main.go -db=create`
`make migrate`(migrate tables) or `go run main.go -db=migrate`
`make watch`(with hot reload) or `go run main.go`
```
4. open `http://localhost:3002/ping` in web browser, and then you will get a "pong" response

## Api examples

* ### sign_up

Post `http://localhost:3002/users/sign_up`

params: email, password, password_confirm

* ### sign_in

Post `http://localhost:3002/users/sign_in`

params: email, password, DEVICE_TYPE, login_type

You will get a header with authorization parameter from response after logging in successfully

* ### auth_ping

Get `http://localhost:3002/auth_ping`

Should add a valid user token to request this api

* ### change_password

Post `http://localhost:3002/users/change_password`

params: origin_password, password, password_confirm

Modify user's password, which needs authorization

* ### cities

Post `http://localhost:3002/cities`

params: language

set language to en, return cities in English.
    set language to zh, return cities in Chinese.

### sms api
(Tencent service, need to set your key in application.yml )

* ### sms

Get `http://localhost:3002/sms`

params: mobile

send sms

### influx apis
(need to install influxdb and modify main.go)

* ### influx_save

Post `http://localhost:3002/influx_save`

params: user_name, local, version

save struct in influxdb

* ### influx_show

Post `http://localhost:3002/influx_save`

get struct message in influxdb

### pay apis
(Alipay service, need to set you key in application.yml)
* ### alipay

Post `http://localhost:3002/alipay`

create alipay bill

* ### alipay_notify

Post `http://localhost:3002/alipay_notify`

receive pay details notify

## other public library
  [Rails-pangu](https://github.com/ruilisi/rails-pangu) is a Rails 6(API Only) boilerplate which follows cutting-edge solutions already adopted by the industry, notablly, Devise, JWT(JSON Web Tokens), Postgres, Redis, Docker, Rspec, RuboCop, CircleCI. It is a solid production-ready starting point for your new backend projects.

## Projects using Go-pangu
  |product|description|
  |----|-----|
  |[eSheep](https://esheep.io/)|Network booster which helps global users access better entertainment content from China.|
  |[cs-server](https://excitingfrog.gitbook.io/im-api/)|agent server(Comming soon!)|
  |soda-server|Comming soon!|

## License
Code and documentation copyright 2020 the [Golang-pangu Authors](https://github.com/ruilisi/go-pangu/graphs/contributors) and [ruilisi Network](https://ruilisi.co/) Code released under the [MIT License](https://github.com/ruilisi/go-pangu/blob/master/LICENSE).
<table frame=void>
<tr>
<td >
<img src="logo.png" width="100px;" alt="hophacker"/>
</td>
</tr>
</table>

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
 <tr>
 <td align="center"><a href="https://github.com/hophacker"><img src="https://avatars2.githubusercontent.com/u/3121413?v=4" width="100px;" alt="hophacker"/> hophacker</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=hophacker" title="Code">💻</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=hophacker" title="Documentation">📖</a> <a href="#infra-hophacker" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
 <td align="center"><a href="https://github.com/tony2100"><img src="https://avatars0.githubusercontent.com/u/37767017?v=4" width="100px;" alt="tony"/> Tony</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=tony2100" title="Code">💻</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=tony2100" title="Documentation">📖</a></td>
 <td align="center"><a href="https://github.com/Ganggou"><img src="https://avatars1.githubusercontent.com/u/41427297?s=400&u=5cc6b0dfa214bc5671f849b3ee94acf597c2c6f4&v=4" width="100px;" alt="Ganggou"/> Ganggou</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=Ganggou" title="Code">💻</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=Ganggou" title="Documentation">📖</a></td>
 <td align="center"><a href="https://github.com/ExcitingFrog"><img src="https://avatars2.githubusercontent.com/u/25655802?s=460&u=23017079e78e3c3bfa57a14bc369607b1b23c470&v=4" width="100px;" alt="Xingo"/> ExcitingFrog</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=ExcitingFrog" title="Code">💻</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=ExcitingFrog" title="Documentation">📖</a></td>
 <td align="center"><a href="https://github.com/Leo7991"><img src="https://avatars1.githubusercontent.com/u/67139714?s=460&u=278212a0d4d8ca824219adcd932dc85d2fd5ae24&v=4" width="100px;" alt="Leo7991"/> Leo7991</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=Leo7991" title="Code">💻</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=Leo7991" title="Documentation">📖</a></td>
 <td align="center"><a href="https://github.com/Daxigua443"><img src="https://avatars1.githubusercontent.com/u/62984061?s=460&u=375eab6d59b2087058c1a30210f8646281971ff7&v=4" width="100px;" alt="Daxigua443"/> Daxigua443</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=Daxigua443" title="Code">💻</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=Daxigua443" title="Documentation">📖</a></td>
 <td align="center"><a href="https://github.com/Soryu23"><img src="https://avatars0.githubusercontent.com/u/67567977?s=460&u=fea632ad315bcdcfeff4de7ac5e2482b249929ac&v=4" width="100px;" alt="Soryu23"/> Soryu23</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=Soryu23" title="Code">💻</a> <a href="https://github.com/ruilisi/golang-pangu/commits?author=Soryu23" title="Documentation">📖</a></td>

</tr>
</table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

go-pangu

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README