README
¶
ginx-server
$ ginx-server -f config.toml
2024-09-24 21:36:51 INF [ginx-server] logging in level: INFO
2024-09-24 21:36:52 INF [ginx-server] message queue is listening
2024-09-24 21:36:52 INF [ginx-server] server is listiening at 127.0.0.1:8080
ginx-server is a quickstart template for standalone http server project, features as bellow:
- ginx: integrate with the ginx framework, supports graceful shutdown, hooks and more features.
- jwt: supports jwt authentication that contains access token and refresh token
- email: support register for email verification code
- ent: ent ORM framework, support datasource from mysql, postgresql, sqlite
- redis: supports redis cache
- mq: support message queue, default using Redis Stream.
- wire: dependency injection with wire
- swagger: support generate swagger api document
- makefile: build project with makefile
commands
build project
$ make build
build project with all supports platforms
$ make build_all
generate swagger
$ make swag_gen
generate ent
$ make ent_gen
generate wire
$ make wire
how to use
clone this project
$ git clone git@github.com:ginx-contribs/ginx-internal.git
checkout specify version
$ git checkout tags/v1.0.0
remove git dir
$ rm -rf .git
init your own git
$ git init
structure
this is standard structure for ginx-server project.
ginx-sever
|-- bin
| |-- debug
| `-- release
|
|-- cmd
| `-- ginx-server
|-- server
| |-- api
| |-- conf
| |-- data
| | |-- cache
| | |-- ent
| | |-- mq
| | `-- repo
| |-- handler
| |-- mids
| |-- pkg
| |-- svc
| `-- types
`-- test
introduction for structure as follows:
bin: binary file output dir, it should be ignored by git.
cmd: main entry package
server: package for http server source code
api: package for http api definition
conf: package for server configuration definition
data: package for datasource
handler: package for logic handler
mids: package for http middlewares
pkg: package for some tool packages
svc: package for record all object dependencies
types: package for error, request params, response definition
Directories