Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zhufuyi committed Dec 5, 2024
1 parent 02d7fff commit 560baf3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,17 @@

**Sponge** is a powerful development framework that integrates `code generation`, `Gin`, and `gRPC`. It offers a rich set of code generation commands, allowing flexible creation of various functional modules that can be combined into complete services (similar to how scattered sponge cells can reorganize into a new sponge). Sponge provides an all-in-one solution for project development, covering code generation, development, testing, API documentation, and deployment, significantly enhancing development efficiency, reducing complexity, and enabling high-quality projects with a "low-code approach".

Sponge is used to quickly and efficiently develop high-performance back-end services for various application scenarios and requirements, including `web` services, `gRPC` services, `http+gRPC` hybrid services, `gRPC gateway API` services.

Sponge not only supports code generation based on Sponge's built-in templates but also allows generating code using custom templates and relevant parameters (e.g., JSON, SQL, Protobuf). Through custom templates, users can generate code required for various projects, without being limited to the Go language.
Sponge is used to quickly and efficiently develop high-performance back-end services for various application scenarios and requirements, including `web` services, `gRPC` services, `http+gRPC` hybrid services, `gRPC gateway API` services. Sponge not only supports code generation based on its built-in templates but also allows you to generate the necessary code for your project using custom templates and related parameters.

<br>

### Sponge Core Design Philosophy

Sponge's core design concept is to reversely generate modular code through `SQL` or `Protobuf` files. These codes can be flexibly and seamlessly combined into various types of backend services, thus greatly improving development efficiency and simplifying backend service development. Sponge has implemented three core functions:
Sponge's core design concept is to reversely generate modular code through `SQL` or `Protobuf` files. These codes can be flexibly and seamlessly combined into various types of backend services, thus greatly improving development efficiency and simplifies the backend service development process:

- If you develop a web or gRPC service with only CRUD API, you don't need to write any go code to compile and deploy it to Linux servers, dockers, k8s, and you just need to connect to the database (e.g., `mysql`, `mongodb`,`postgresql`,`sqlite`) to automatically generate the complete backend service go code by sponge.
- If you develop general web, gRPC, http+gRPC, gRPC gateway services, you only need to focus on the three parts of `define tables in the database`, `define API description information in the protobuf file`, and `fill in business logic code in the generated template file`, and other go codes (including CRUD api) are generated by sponge.
- Sponge generates the necessary code for various projects through custom templates and parameters, such as frontend code, backend code, test code, deployment scripts, etc.
- Generate the necessary code for your project (not limited to Go language) through custom templates and parameters (such as JSON, SQL, Protobuf), such as backend code, frontend code, configuration files, test code, build and deployment scripts, etc.

<br>

Expand Down
8 changes: 3 additions & 5 deletions assets/readme-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,17 @@

**sponge** 是一个集成了`代码生成``Gin``gRPC` 的强大开发框架,提供丰富的代码生成命令,可灵活生成各类功能模块,并组合成完整的服务(类似打散的海绵细胞能重新组合成新的海绵)。sponge 提供一站式项目开发解决方案,涵盖代码生成、开发、测试、API 文档生成和部署,大幅提升开发效率,降低开发难度,实现以"低代码"方式构建高质量项目。

sponge 用来快速开发各种应用场景和需求的高性能后端服务,包括 `web` 服务、`gRPC` 服务、`http+gRPC` 混合服务、 `gRPC网关API`服务等。

sponge 不仅支持基于自带模板生成代码,还支持基于自定义模板和相关参数(如 json、sql、protobuf)生成代码。通过自定义模板,可以生成各类项目所需的代码(不局限于 Go 语言)。
sponge 用来快速高效开发各种应用场景的高性能后端服务,包括 `web` 服务、`gRPC` 服务、`http+gRPC` 混合服务、 `gRPC网关API`服务等。sponge 不仅支持基于自带的模板生成代码,还支持基于自定义模板和相关参数生成你的项目所需的代码。

<br>

### sponge 核心设计理念

sponge 的核心设计理念是通过 `SQL``Protobuf` 文件逆向生成模块化的代码,这些代码可以灵活、无缝地组合成多种类型的后端服务,从而大幅大提升开发效率,简化后端服务开发,sponge已实现了三大核心功能
sponge 的核心设计理念是通过 `SQL``Protobuf` 文件逆向生成模块化的代码,这些代码可以灵活、无缝地组合成多种类型的后端服务,从而大幅大提升开发效率,简化后端服务开发流程

- 如果开发只有 CRUD api 的 web 或 gRPC 服务,不需要编写任何 go 代码就可以编译并部署到 linux 服务器、docker、k8s 上,只需要连接到数据库(例如`mysql`, `mongodb`,`postgresql`,`sqlite`)就可以一键自动生成完整的后端服务 go 代码。
- 如果开发通用的 web、gRPC、http+gRPC、gRPC 网关等服务,只需聚焦`在数据库定义表``在protobuf文件定义api描述信息``在生成的模板文件填写业务逻辑代码`这三部分,其他 go 代码(包括CRUD api)都由 sponge 来生成。
- 通过自定义模板和参数生成各类项目所需的代码,例如前端代码、后端代码、测试代码、部署脚本等
- 通过自定义模板和参数(如 json、sql、protobuf)生成你的项目所需的代码(不局限于 Go 语言),例如后端代码、前端代码、配置文件、测试代码、构建和部署脚本等

<br>

Expand Down

0 comments on commit 560baf3

Please sign in to comment.