README-EN.md

jzero

Free your hands and have more time to play games

中文 | ENGLISH

Introduction

Create a project through a template and generate Server/Client/Model code based on proto/api/sql files.

It has the following features:

• Based on the go-zero framework but not limited to the go-zero framework. In theory, it can access any framework based on template features

• Optimize the existing pain points of the go-zero framework and expand new features, fully compatible with the go-zero framework

• Generate code through minimalist instructions based on configuration files

• Maintain commonly used development templates and generate projects that meet enterprise-level code specifications with one click

For more details please see: https://jzero.jaronnie.com/en. The English documentation is incomplete and is still being supplemented

Install

go install github.com/jzero-io/jzero@latest
# check tools
jzero check

docker

docker pull ghcr.io/jzero-io/jzero:latest

Quick start

# new project
jzero new your_project
# generate server code
cd your_project
jzero gen
# download dependencies
go mod tidy
# generate swagger json
jzero gen swagger
# generate http sdk
jzero gen sdk
# run server
go run main.go server

docker

docker run --rm -v ${PWD}:/app ghcr.io/jzero-io/jzero:latest new your_project
cd your_project
docker run --rm -v ${PWD}:/app ghcr.io/jzero-io/jzero:latest gen
# download dependencies
go mod tidy
# generate swagger json
docker run --rm -v ${PWD}:/app ghcr.io/jzero-io/jzero:latest gen swagger
# generate http sdk
docker run --rm -v ${PWD}:/app ghcr.io/jzero-io/jzero:latest gen sdk
# 运行服务端
go run main.go server

For more examples code please see: https://github.com/jzero-io/examples

Project Practice please see: https://jzero.jaronnie.com/project

Roadmap

please see: https://jzero.jaronnie.com/roadmap

Contributors

CONTRIBUTING

Acknowledgements

This project is supported by JetBrains Open Source development License.

Donate

Stargazers over time

Contact me