## 📘 Documents
- [Project Document](https://sanjayheaven.github.io/ggb/)
- [Swagger Api Document](https://ggb.gganbu.services/swagger/index.html)
## 🎬 Introduction
A development boilerplate based on the Gin framework, aimed at helping developers quickly build and develop web applications.
- [English](./README.md)
- [中文介绍](docs/README_zh.md)
## 👀 Keywords
[Go](https://github.com/golang/go)
[Gin](https://github.com/gin-gonic/gin)
[Cobra](https://github.com/spf13/cobra)
[Viper](https://github.com/spf13/viper)
[Gorm](https://github.com/go-gorm/gorm)
[Gin-Swagger](https://github.com/swaggo/gin-swagger)
[Air](https://github.com/cosmtrek/air)
[Logrus](https://github.com/sirupsen/logrus)
[Lumberjack](https://github.com/natefinch/lumberjack)
[Zap](https://github.com/uber-go/zap)
[Jwt](https://github.com/golang-jwt/jwt)
https://www.topgoer.com/
## ✨ Features
- **Fast Development**: Using the **Gin** framework and related tools to speed up the development and iteration process of the project..
- **Easy to use**: Follow the [project-layout](https://github.com/golang-standards/project-layout/tree/master) specification and provide a clear and simple code structure so that even beginners can easily get started.
- **Advanced CLI**: Using **Cobra** to build modern command line tools to simplify project management and operations.
- **Hot Reload**: Using **Air** tool, support hot reload, improve development efficiency.
- **Logging system**: Integrated **Logrus**, **Zap** and **Lumberjack** to achieve all-round log recording and management.
- **Database Support**: Integrated **Gorm**, support mainstream databases such as MySQL, PostgreSQL, etc.
- **Flexible Middleware**: Integrate common middleware to easily implement functions such as logging, authentication, cross-domain, and flow control.
- **API Document**: Use **Gin-Swagger** to generate API documents for easy viewing and debugging of interfaces.
## 🚀 Quick Start
```sh
git clone https://github.com/sanjayheaven/ggb.git
cd ggb
go mod download
```
### Configuration Setup
- Navigate to the `configs` directory, copy the `config.example.yaml` file, and rename it to `config.yaml`.
```sh
cp configs/config.example.yaml configs/config.yaml
```
- Modify the configuration items in the `config.yaml` file.
```sh
vi configs/config.yaml
```
### Run the Application
- Run the project using [air](https://github.com/cosmtrek/air) **【Recommended】**
```sh
air
```
- Run the project using [go run](https://golang.org/cmd/go/#hdr-Compile_and_run_Go_program)
```sh
go run main.go server
```
## 🔨 Build
```sh
make build
```
## 🪤 Deployment
### docker-compose
Deploy the application using **_docker-compose_**.
Ensure that Docker is installed on the server, and you are familiar with the usage of docker compose.
- Copy the `deployments/docker-compose.yml` configuration file to the project root directory.
- Execute the following command to start the application
```sh
docker compose up -d
```
## 🤝 Support
- Star 🌟 the project
- Welcome to submit [issue](). Thank you for your support
- Help promote it on social media and recommend it to friends
- You can also sponsor a cup of coffee on [Ko-Fi](https://ko-fi.com/dorvan) or [Buy Me A Coffee](https://www.buymeacoffee.com/dorvan)
