Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinkhello/go-starter
Go 服务框架脚手架. 整合 echo、swag、viper、nsq、logrus、fx、xorm、cobra 等第三方库
https://github.com/pinkhello/go-starter
cobra echo echo-swagger fx github-actions golangci-lint logrus nsq swag swagger viper xorm xormplus
Last synced: 8 days ago
JSON representation
Go 服务框架脚手架. 整合 echo、swag、viper、nsq、logrus、fx、xorm、cobra 等第三方库
- Host: GitHub
- URL: https://github.com/pinkhello/go-starter
- Owner: pinkhello
- License: apache-2.0
- Created: 2021-03-06T11:28:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-13T10:57:29.000Z (over 2 years ago)
- Last Synced: 2023-11-07T18:14:38.805Z (about 1 year ago)
- Topics: cobra, echo, echo-swagger, fx, github-actions, golangci-lint, logrus, nsq, swag, swagger, viper, xorm, xormplus
- Language: Go
- Homepage:
- Size: 107 KB
- Stars: 158
- Watchers: 2
- Forks: 29
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-starter   
## github activity
[](https://github.com/pinkhello/go-starter/stargazers)
[](https://starchart.cc/pinkhello/go-starter)
## Demo
Demo: [房产CRM](http://121.4.242.26)
- url: http://121.4.242.26 (test/123456)。
- BE [go-starter](https://github.com/pinkhello/go-starter)
- FE [ant-design-vue-pro](https://pro.antdv.com/)
## thirdparty
- [X] Github Actions
- [X] Custom Logger [logrus](https://github.com/sirupsen/logrus)
- [X] CLI Command [cobra](https://github.com/spf13/cobra)
- [X] Configuration [viper](https://github.com/spf13/viper)
- [X] Web [echo](https://github.com/labstack/echo)
- [X] DI/IOC [fx](https://github.com/uber-go/fx)
- [X] ORM [xorm](https://github.com/go-xorm/xorm)
- [X] Swagger generator [swag](https://github.com/swaggo/swag) [echo-swagger](https://github.com/swaggo/echo-swagger)
- [X] Messaging [NSQ](https://github.com/nsqio/nsq)
- [X] golangci-lint [golangci-lint](https://github.com/golangci/golangci-lint)
- [ ] Migrate [migrate](https://github.com/golang-migrate/migrate)
- [ ] ......
## code layer
```shell
- app # application main
- cmd
- ...
- config # config
- deploy # ci/cd
- mysql # mysql docker-compose
- nsq # nsq docker-compose
- ... # other
- docs # swag gen swagger2.0 doc
- internal # core
- controller # http handler（controller）
- http # http sever startup
- lib # lib
- models # models
- nsq # nsq producer & nsq consumer startup
- repository # repository
- service # service
- utils # util
- ...
- ...
```
## Build & Publish & Deploy
### swag tips
```shell
> swag init -g app/main.go
```
`swagger url: http://{IP}:{PORT}/swagger/index.html`
### build
- local
```shell
> cd .
> docker build . --file deploy/Dockerfile --tag {ImageTag}
```
- github action
```shell
> { secrets.ACCESS_USERNAME }: `your docker hub username`
```
### be deploy
1. `docker network`:`go_starter_network`
```shell
> docker network create go_starter_network
```
2. `mysql` & `nsq`
```shell
# MYSQL start
> cd deploy/mysql
> docker-compose up -d
# NSQ start
> cd deploy/nsq
> docker-compose up -d
```
3. `be server`
```shell
# go-starter start
> cd deploy
> docker-compose up -d
```
4. `Health`
```shell
http://{IP}:{PORT}/
```
### Other
- Dockerfile
```dockerfile
# build go
FROM golang:1.16.1-alpine3.13 as builder
......
RUN CGO_ENABLED=0 GOOS=linux go build -o go_starter app/main.go
# package stage
FROM alpine
......
# copy from builder
COPY --from=builder /app/go_starter /app
# ......
```
- Uber IOC/DI: [fx](https://pkg.go.dev/go.uber.org/fx)
```go
//other code
......
var (
httpCmd = &cobra.Command{
Use: "http",
Short: "Start Http REST API",
Run: initHTTP,
}
)
func initHTTP(cmd *cobra.Command, args []string) {
fx.New(inject()).Run()
}
func inject() fx.Option {
return fx.Options(
fx.Provide(
config.NewConfig,
utils.NewTimeoutContext,
),
libs.XormModule,
repository.Module,
service.Module,
controller.Module,
nsq.ProducerModule,
nsq.ConsumerModule,
http.Module,
)
}
```