README
¶
pzero
English | 简体中文
Introduction
pzero is a framework developed based on the go-zero framework and go-zero/goctl tool. It can initialize api/gateway/rpc projects with a single command.
Automatically generate server and client framework code based on descriptive files (api/proto/sql). With built-in pzero-skills, AI can generate business logic code that follows best practices, reducing development cognitive load and freeing your hands!
Key features:
- Flexible control of pzero configurations through configuration files/command-line arguments/environment variables, simple commands to generate code, AI-friendly
- Support generating code based on git changed files, support generating code for specified descriptive files or ignoring specified descriptive files, improving code generation efficiency for large projects
- Built-in common development templates with enhanced template features, support for custom templates, building exclusive enterprise internal code templates, greatly reducing development costs
For inherited framework documentation, see the upstream jzero documentation.
Design Philosophy
- Developer Experience: Provide a simple, easy-to-use, production-ready solution to enhance developer experience
- Template Driven: All code generation is based on template rendering, default generation follows best practices, and supports custom template content
- Ecosystem Compatibility: Does not modify go-zero and go-zero/goctl, maintains ecosystem compatibility, while solving existing pain points and extending new features
- Team Development: Team development friendly through module layering and plugin design
- Interface Design: No dependency on specific databases/caches/configuration centers and other infrastructure, choose freely according to actual needs
For inherited framework documentation, see the upstream jzero documentation.
Quick Start
# Install pzero
go install github.com/polpo-space/pzero/cmd/pzero@latest
# One-click install required tools
pzero check
# One-click create project
pzero new your_project
cd your_project
# Download dependencies
go mod tidy
# Start server
go run main.go server
# Access swagger ui
http://localhost:8001/swagger
docker
# One-click create project
docker run --rm -v ${PWD}:/app ghcr.io/polpo-space/pzero:latest new your_project
cd your_project
# Download dependencies
go mod tidy
# Start server
go run main.go server
# Access swagger ui
http://localhost:8001/swagger
For more example code, please visit: https://github.com/jzero-io/examples
Ecosystem
The inherited upstream ecosystem remains compatible:
- jzero-intellij: https://github.com/jzero-io/jzero-intellij
- jzero-admin: https://github.com/jzero-io/jzero-admin
- templates: https://templates.jzero.io
For more ecosystem, please visit: https://docs.jzero.io/ecosystem/
Contributors
Stargazers over time
Disclaimer
pzero is released under the MIT License and is provided completely free of charge. The authors and contributors assume no liability for any direct or indirect consequences arising from the use of this software, including but not limited to performance degradation, data loss, service interruptions, or any other type of damage.
No Warranty: This software comes with no express or implied warranties, including but not limited to fitness for a particular purpose, non-infringement, merchantability, and reliability.
User Responsibility: By using this software, you understand and agree to assume all risks and responsibilities associated with its use.
Directories