README
¶
🦅 eagle
Introduction
A Go framework suitable for rapid business development, which can quickly build API services or Web sites.
Features
- Router Gin
- Middleware Gin
- Database GORM
- Document Swagger 生成
- Config Viper
- Auth JWT
- Validator validator
- Cron cron
- Test GoConvey
- CI/CD GitHub Actions
- Lint GolangCI-lint
Directory Structure
├── Makefile # 项目管理文件
├── api # grpc客户端和Swagger 文档
├── cmd # 脚手架目录
├── config # 配置文件统一存放目录
├── docs # 框架相关文档
├── internal # 业务目录
│ ├── cache # 基于业务封装的cache
│ ├── handler # http 接口
│ ├── middleware # 自定义中间件
│ ├── model # 数据库 model
│ ├── dao # 数据访问层
│ ├── ecode # 业务自定义错误码
│ ├── routers # 业务路由
│ ├── server # http server 和 grpc server
│ └── service # 业务逻辑层
├── logs # 存放日志的目录
├── main.go # 项目入口文件
├── pkg # 公共的 package
├── test # 单元测试依赖的配置文件，主要是供docker使用的一些环境配置文件
└── scripts # 存放用于执行各种构建，安装，分析等操作的脚本
Installtion CLI
# go >= 1.16
go install github.com/go-eagle/eagle/cmd/eagle@latest
# go < 1.16
go get github.com/go-eagle/eagle/cmd/eagle
Quick Start
eagle new eagle-demo
# or
eagle new github.com/foo/eagle-demo
# build
make build
# run
./eagle-demo
Documentation
CHANGELOG
Who is using
Discussion
Stargazers over time
License
MIT. See the LICENSE file for details.
Documentation
¶
Overview ¶
*
* * ____ __ * / __/__ ____ _/ /__ * / _// _ `/ _ `/ / -_) * /___/\_,_/\_, /_/\__/ * /___/ * * * generate by http://patorjk.com/software/taag/#p=display&f=Small%20Slant&t=Eagle
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
eagle
module
|
|
|
protoc-gen-go-gin
module
|
|
|
examples
|
|
|
config
command
|
|
|
helloworld/client
command
|
|
|
helloworld/server
command
|
|
|
queue/kafka
command
|
|
|
queue/nats
command
|
|
|
queue/rabbitmq
command
|
|
|
registry
command
*
|
* |
|
trace
command
*
|
* |
|
internal
|
|
|
pkg
Package pkg 计数器，可以用于业务的各种模型统计使用 场景：常用于重复策略，或者反作弊处理控制
|
Package pkg 计数器，可以用于业务的各种模型统计使用 场景：常用于重复策略，或者反作弊处理控制 |
|
pkg
|
|
|
app
Package app eagle defines something for app
|
Package app eagle defines something for app |
|
container/group
Package group provides a sample lazy load container.
|
Package group provides a sample lazy load container. |
|
log
Package log span logger for trace reference: https://github.com/jaegertracing/jaeger/tree/master/examples/hotrod/pkg/log
|
Package log span logger for trace reference: https://github.com/jaegertracing/jaeger/tree/master/examples/hotrod/pkg/log |
|
sync/errgroup
Package errgroup provides synchronization, error propagation, and Context errgroup 包为一组子任务的 goroutine 提供了 goroutine 同步,错误取消功能.
|
Package errgroup provides synchronization, error propagation, and Context errgroup 包为一组子任务的 goroutine 提供了 goroutine 同步,错误取消功能. |
Click to show internal directories.
Click to hide internal directories.