English ｜中文

Gone Web MySQL Template Project

This is a web application template project based on the Gone framework, integrated with MySQL database support, which can serve as a starting point for developing web applications.

Project Features

Built on the Gone framework using dependency injection design pattern
Integrated MySQL database support
Provides complete project structure and code organization
Supports Docker deployment
Includes user management example code

Tech Stack

Gone - Go application framework based on dependency injection
Gin - Web framework
Xorm - ORM framework
MySQL - Database
Docker - Containerized deployment

Directory Structure

.
├── cmd                 # Application entry
│   └── server          # Server entry
├── config              # Configuration files
├── internal            # Internal code
│   ├── controller      # Controllers
│   ├── interface       # Interface definitions
│   ├── module          # Module implementations
│   ├── pkg             # Utility packages
│   └── router          # Route definitions
├── scripts             # Script files
│   └── mysql           # MySQL initialization scripts
└── tests               # Test files
    └── api             # API tests

Quick Start

Prerequisites

Go 1.24 or higher
MySQL 8.0 or higher
Docker and Docker Compose (optional, for containerized deployment)

Local Development

Install dependencies

go mod download

Configure database

Edit config/default.properties file, set database connection information:

db.host=localhost
db.port=3306
db.name=demo
db.username=root
db.password=123456

Run the project

make run

The service will start at http://localhost:8080

Docker Deployment

Build Docker image

make build-docker

Start service

docker compose up -d

The service will start at http://localhost:8080, and MySQL database will be available at localhost:3306

Configuration Guide

Project configuration file is located at config/default.properties, main configuration items include:

server.port - Service port, default is 8080
server.mode - Gin service mode, options are debug, test, release, default is release
server.health-check - Health check path, default is /api/health-check
db.host - Database host
db.port - Database port
db.name - Database name
db.username - Database username
db.password - Database password

Development Guide

Adding New APIs

Define interface in internal/interface
Implement interface in internal/module
Create controller in internal/controller
Register route in internal/router

Generating Mocks

The project uses mockgen to generate mock code:

go generate ./...

gone-io/template-v2-web-mysql

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages