backend-layout

module
v0.0.0-...-3839eb7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 5, 2024 License: MIT

README

backend-layout

a dead simple go http server layout project, some of the technologies used are as follows:

  • gin
  • gorm
  • redis
  • jwt
  • swagger
  • wire

layout

The explanation of the project structure is as follows

├─assets # static resources
├─bin # binary files that will be ignored by git, only used for test in local
├─cmd 
│  └─app # binary module
├─internal 
│  ├─api # open http api module
│  ├─conf # app configuration
│  ├─core # core logic
│  ├─data # data source
│  ├─handler # system http api
│  ├─pkg # some internal packages can not be imported by others
│  └─types
└─pkg # some open packages can be imported by others

how to use

build project

make build

generate project files

mae gen

initialize project dependencies

make init

Directories

Path Synopsis
cmd
app
internal
api
api/docs
Package docs Code generated by swaggo/swag at 2024-03-05 22:17:44.8864028 +0800 CST m=+2.739990801.
Package docs Code generated by swaggo/swag at 2024-03-05 22:17:44.8864028 +0800 CST m=+2.739990801.
handler/docs
Package docs Code generated by swaggo/swag at 2024-03-05 22:17:55.277895 +0800 CST m=+2.658018401.
Package docs Code generated by swaggo/swag at 2024-03-05 22:17:55.277895 +0800 CST m=+2.658018401.
pkg
vax
Package vax validation provides configurable and extensible rules for validating data of various types.
Package vax validation provides configurable and extensible rules for validating data of various types.
vax/is
Package is provides a list of commonly used string vax rules.
Package is provides a list of commonly used string vax rules.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL