Skip to content

Commit edb089a

Browse files
zhufuyizhufuyi
committed
docs: update readme
1 parent 209e6b8 commit edb089a

2 files changed

Lines changed: 52 additions & 120 deletions

File tree

‎README.md‎

Lines changed: 30 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -15,82 +15,47 @@
1515

1616
</div>
1717

18+
---
19+
1820
<br>
1921

2022
### Introduction
2123

22-
**Sponge** is a powerful and easy-to-use Go development framework. It integrates **automatic code generation**, **Web frameworks (Gin)**, and **microservice frameworks (gRPC)**, covering the full lifecycle from project generation, development, and testing to API documentation and deployment.
24+
**Sponge** is a powerful and easy-to-use **Go development framework**. Built on the core philosophy of **"Definition is Code"**, it aims to reshape the backend development experience through automatic generation technology, unleashing productivity and boosting development efficiency.
25+
26+
Sponge deeply integrates a **code generation engine**, **Gin (Web framework)**, and **gRPC (microservice framework)**, covering the full software lifecycle from project generation, development, and testing to API documentation and deployment.
2327

24-
Sponge's core philosophy is **"Definition is Code"**. By parsing SQL, Protobuf, and JSON configuration files, it generates modular backend service code. You can flexibly combine these code modules like building blocks to quickly construct various backend systems ranging from monolithic applications to microservice clusters (including RESTful API, gRPC, HTTP+gRPC, gRPC Gateway, etc.).
28+
**Core Features:**
2529

26-
Sponge aims to improve the development efficiency and code quality of backend services. Through a **low-code** approach, it helps developers completely eliminate tedious repetitive work (such as CRUD, routing configuration, and project structure setup), allowing them to focus on the implementation of core business logic.
30+
* **Definition-Driven Development**: Automatically parses SQL, Protobuf, and JSON configuration files to generate high-quality modular code.
31+
* **LEGO-style Assembly**: Flexibly combines code modules in a loosely coupled manner, supporting the rapid construction of **monolithic applications**, **microservice clusters**, and **gateway services**, including `RESTful API`, `gRPC`, `HTTP+gRPC`, `gRPC Gateway`, etc.
32+
* **Low Code, High Efficiency**: Completely eliminates tedious repetitive work such as CRUD, routing configuration, and service governance. Developers only need to focus on core business logic to deliver standardized, high-quality backend services.
2733

2834
<br>
2935

3036
### Why Choose Sponge?
3137

32-
- **Extreme Development Efficiency**: Automatically generates CRUD APIs, project scaffolding, and extensive boilerplate code, letting developers say goodbye to repetitive labor.
33-
- **Out of the Box**: Provides a complete development toolchain (Generate → Develop → Test → Deploy → Monitor), eliminating the need to piece together fragmented tools.
38+
- **Extreme Development Efficiency**: One-click generation of complete, production-ready backend services (Zero-Code), including CRUD, routing, documentation, and service framework code, multiplying development efficiency.
39+
- **Out-of-the-box Toolchain**: Provides a complete development toolchain (Generation → Business Logic → Testing → Deployment → Monitoring), eliminating the need to piece together fragmented tools.
3440
- **Industry Best Practices**: Built on the mainstream Go community tech stack (Gin/GORM/gRPC/Protobuf, etc.), with a standardized architecture to reduce technology selection risks.
35-
* **Flexible and Extensible**: Supports custom templates, not limited to Go; can extend to generate frontend code, test scripts, and arbitrary code.
36-
- **Gentle Learning Curve**: Low entry barrier and easy to get started.
37-
- **Suitable for Team Collaboration**: Unified project structure improves team collaboration efficiency and code maintainability.
38-
- **Fusion of Low-Code and AI**:
39-
- **Sponge** handles the generation of standardized infrastructure code (APIs, data layer, service frameworks).
40-
- **AI Models** perceive the project context and assist in generating core business logic, achieving "Automated Infrastructure, Intelligent Business".
41-
42-
<br>
43-
44-
### Key Features
45-
46-
<details>
47-
<summary> <b>One-click Generation of Complete Backend Services (Zero-Code).</b> </summary>
48-
49-
> For scenarios requiring only basic `CRUD` capabilities (Web, gRPC, or HTTP+gRPC), **no Go code needs to be written**. simply connect to a database (MySQL, MongoDB, PostgreSQL, SQLite) to generate a complete backend service with one click, supporting direct deployment to Linux, Docker, or Kubernetes.
50-
</details>
51-
52-
<details>
53-
<summary> <b>Protocol-Driven Development for General Backend Services, from Definition to Implementation in One Step.</b> </summary>
54-
55-
> For general `Web`, `gRPC`, `HTTP+gRPC`, or `gRPC Gateway` services, a standardized development process is adopted:
56-
> 1. **Define Data**: Design SQL DDL.
57-
> 2. **Define Interface**: Write Protobuf IDL.
58-
> 3. **Generate Code**: Sponge automatically generates CRUD, routing, documentation, and glue code.
59-
> 4. **Fill Business**: Use Sponge's built-in AI model or manually complete the core logic.
60-
61-
</details>
62-
63-
<details>
64-
<summary> <b>Visual Code Generation, Simple and Easy to Use.</b> </summary>
65-
66-
> Say goodbye to complex command-line arguments. Sponge provides an intuitive Web UI, allowing you to complete code generation through simple form configurations, lowering the barrier to entry.
67-
</details>
68-
69-
<details>
70-
<summary> <b>AI Collaborative Development.</b> </summary>
71-
72-
> Sponge integrates with AI models like DeepSeek, ChatGPT, and Gemini. Sponge handles the tedious engineering structure and standardized code, while the AI model focuses on understanding requirements and generating specific business logic code, significantly improving code consistency and R&D speed.
73-
74-
</details>
75-
76-
<details>
77-
<summary> <b>Support for Custom Templates, Flexible Extension.</b> </summary>
78-
79-
> Not limited to the Go language, you can generate frontend code, test scripts, CI/CD configurations, and any text file through custom templates to meet specific team engineering needs.
80-
81-
</details>
41+
- **Extremely Low Learning Curve**: Easy to get started and beginner-friendly, while also meeting the customization needs of senior developers.
42+
- **Ideal for Team Collaboration**: Unifies project structure, improving team collaboration efficiency and code maintainability.
43+
* **Flexible and Extensible**: Supports custom templates, not limited to Go; capable of extending to frontend, test scripts, and other arbitrary code generation.
44+
- **AI-Driven Development (AI-Native)**:
45+
- **Sponge:** automatically builds standardized infrastructure (API, data layer, service framework).
46+
- **AI Assistant:** analyzes project context and generates code intelligently fill in core business logic based on project context, achieving "Infrastructure Automation, Business Intelligence".
8247

8348
<br>
8449

8550
### Applicable Scenarios
8651

8752
Sponge is suitable for building high-performance, maintainable backend systems, specifically for:
8853

89-
- **Rapid development of RESTful API services**
90-
- **Building large-scale microservice architectures**
91-
- **Cloud-native application development**
92-
- **Rapid refactoring and migration of legacy projects**
93-
- **Standardized engineering templates for Go beginners or teams**
54+
- **Rapid development of RESTful API services.**
55+
- **Building large-scale microservice architectures.**
56+
- **Cloud-native application development.**
57+
- **Rapid refactoring and migration of legacy projects.**
58+
- **Standardized engineering templates for Go beginners or teams.**
9459

9560
<br>
9661

@@ -133,13 +98,14 @@ No installation required, experience the code generation feature directly in you
13398

13499
Sponge follows the "batteries included" principle, integrating 30+ mainstream Go ecosystem components, loaded on demand:
135100

136-
| Category | Component |
137-
| :--- |:------------------------------------------------------|
138-
| **Frameworks** | Gin, gRPC |
139-
| **Database** | GORM (MySQL, PostgreSQL, SQLite, etc.), MongoDB |
140-
| **Cache/Messaging** | Redis, Kafka, RabbitMQ |
141-
| **Service Governance** | Etcd, Consul, Nacos, Jaeger, Prometheus, OpenTelemetry |
142-
| **Others** | DTM (Distributed Transaction), WebSocket, Swagger, PProf |
101+
| Category | Component |
102+
|:-----------------------|:---------------------------------------------------------|
103+
| **Frameworks** | Gin, gRPC |
104+
| **Database** | GORM (MySQL, PostgreSQL, SQLite, etc.), MongoDB |
105+
| **Cache/Messaging** | Redis, Kafka, RabbitMQ |
106+
| **Service Governance** | Etcd, Consul, Nacos, Jaeger, Prometheus, OpenTelemetry |
107+
| **Others** | DTM (Distributed Transaction), WebSocket, Swagger, PProf |
108+
| ... | ... |
143109

144110
👉 [**View the complete list of tech stacks and components**](https://go-sponge.com/component/).
145111

‎assets/readme-cn.md‎

Lines changed: 22 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,46 @@
11
## [English](../README.md) | 简体中文
22

3+
---
4+
35
<br>
46

57
### 简介
68

7-
**Sponge** 是一款功能强大且易用的 Go 开发框架，它整合了 **代码自动生成**、**Web 框架 (Gin)** 和 **微服务框架 (gRPC)**，覆盖了从项目生成、开发、测试、API 文档到部署的全生命周期。
9+
**Sponge** 是一款强大且易用的 **Go 开发框架**。它基于 **"Definition is Code" (定义即代码)** 的核心理念，致力于通过自动生成技术重塑后端开发体验，解放生产力，大幅提升开发效率。
10+
11+
Sponge 深度集成了 **代码生成引擎**、 **Gin (Web 框架)** 与 **gRPC (微服务框架)**，涵盖了从项目生成、开发、测试、API 文档到部署的软件全生命周期。
812

9-
Sponge 的核心理念是 **"Definition is Code" (定义即代码)**。通过解析 SQL、Protobuf 和 JSON 配置文件生成模块化的后端服务代码。你可以像搭积木一样，灵活组合这些代码模块，快速构建从单体应用到微服务集群的各种后端系统（包括 RESTful API、gRPC、HTTP+gRPC、gRPC Gateway 等）。
13+
**核心特性：**
1014

11-
Sponge 旨在提升后端服务的开发效率与代码质量，通过 **低代码** 方式，帮助开发者彻底消除繁琐的重复性工作（如 CRUD、路由配置、项目结构搭建等），只需专注于核心业务逻辑的实现。
15+
* **定义驱动开发**：自动解析 SQL、Protobuf 和 JSON 配置文件，生成高质量的模块化代码。
16+
* **积木式组装**：以松耦合的方式灵活组合代码模块，支持快速构建 **单体应用**、**微服务集群** 及 **网关服务**，包括 `RESTful API`、`gRPC`、`HTTP+gRPC`、`gRPC Gateway` 等。
17+
* **低代码，高效率**：彻底消除 CRUD、路由配置、服务治理等繁琐的重复性工作。开发者只需专注于核心业务逻辑，即可交付标准化、高质量的后端服务。
1218

1319
<br>
1420

1521
### 为什么选择 Sponge？
1622

17-
- **极致的开发效率**： 自动生成 CRUD API、项目脚手架及大量 Boilerplate（样板）代码，让开发者告别重复劳动。
18-
- **开箱即用**：提供完整的开发工具链（生成 → 开发 → 测试 → 部署 → 监控），无需拼凑碎片化工具。
23+
- **极致的开发效率**：一键生成可直接线上部署的完整后端服务 (Zero-Code)，包括 CRUD、路由、文档及服务框架代码等，开发效率成倍提升。
24+
- **开箱即用的工具链**：提供完整的开发工具链（生成 → 填充业务 → 测试 → 部署 → 监控），无需拼凑碎片化工具。
1925
- **行业最佳实践**：基于 Go 社区主流技术栈（Gin/GORM/gRPC/Protobuf 等）构建，架构规范，降低技术选型风险。
20-
* **灵活可扩展**：支持自定义模板，不仅限于 Go，还可扩展前端、测试脚本等任意代码生成。
21-
- **学习曲线平缓**：入门门槛低，易于上手。
26+
- **极低的学习门槛**：上手简单，对新手友好，同时满足资深开发者的定制需求。
2227
- **适合团队协作**：统一项目结构，提升团队协作效率和代码可维护性。
23-
- **低代码与 AI 融合**：
24-
- **Sponge** 负责生成标准化的基础设施代码（API、数据层、服务框架）。
25-
- **AI 模型** 感知项目上下文，辅助生成核心业务逻辑，实现“基建自动化，业务智能化”。
26-
27-
<br>
28-
29-
### 关键特性
30-
31-
<details>
32-
<summary> <b>一键生成完整后端服务 (Zero-Code)。</b> </summary>
33-
34-
> 针对仅需基础 `CRUD` 能力的场景（Web、gRPC 或 HTTP+gRPC），**无需编写一行 Go 代码**。只需连接数据库（MySQL、MongoDB、PostgreSQL、SQLite），即可一键生成完整的后端服务，并支持直接部署到 Linux、Docker 或 Kubernetes。
35-
</details>
36-
37-
<details>
38-
<summary> <b>协议驱动开发通用后端服务，从定义到实现一步到位。</b> </summary>
39-
40-
> 针对通用的 `Web`、`gRPC`、`HTTP+gRPC` 或 `gRPC Gateway` 服务，采用标准化的开发流程：
41-
> 1. **定义数据**：设计 SQL DDL。
42-
> 2. **定义接口**：编写 Protobuf IDL。
43-
> 3. **生成代码**：Sponge 自动生成 CRUD、路由、文档及胶水代码。
44-
> 4. **填充业务**：利用 Sponge 内置的 AI 模型或手动补全核心逻辑。
45-
46-
</details>
47-
48-
<details>
49-
<summary> <b>可视化代码生成，简单易用。</b> </summary>
50-
51-
> 告别复杂的命令行参数。Sponge 提供直观的 Web UI，通过简单的表单配置即可完成代码生成，降低上手门槛。
52-
</details>
53-
54-
<details>
55-
<summary> <b>AI 协同开发。</b> </summary>
56-
57-
> Sponge 本身集成 DeepSeek、ChatGPT、Gemini 等 AI 模型。Sponge 处理繁琐的工程结构与标准化代码，AI 模型专注于理解需求并生成具体的业务逻辑代码，显著提升代码一致性与研发速度。
58-
59-
</details>
60-
61-
<details>
62-
<summary> <b>支持自定义模板，灵活扩展。</b> </summary>
63-
64-
> 不局限于 Go 语言，你可以通过自定义模板生成前端代码、测试脚本、CI/CD 配置等任何文本文件，满足团队特定的工程化需求。
65-
66-
</details>
28+
* **灵活可扩展**：支持自定义模板，不仅限于 Go，还可扩展前端、测试脚本等任意代码生成。
29+
- **AI 驱动开发 (AI-Native)**：
30+
- **Sponge：** 自动构建标准化的基础设施（API、数据层、服务框架）。
31+
- **AI 助手：** 基于项目上下文，智能填充核心业务逻辑，实现“基建自动化，业务智能化”。
6732

6833
<br>
6934

7035
### 适用场景
7136

7237
Sponge 适用于构建高性能、可维护的后端系统，特别适合：
7338

74-
- **快速开发 RESTful API 服务**
75-
- **构建大规模微服务架构**
76-
- **云原生应用开发**
77-
- **旧有项目的快速重构与迁移**
78-
- **Go 语言初学者或团队的标准化工程模板**
39+
- **快速开发 RESTful API 服务。**
40+
- **构建大规模微服务架构。**
41+
- **云原生应用开发。**
42+
- **旧有项目的快速重构与迁移。**
43+
- **Go 语言初学者或团队的标准化工程模板。**
7944

8045
<br>
8146

@@ -125,6 +90,7 @@ Sponge 遵循“电池内置”原则，集成了 30+ 个 Go 生态主流组件
12590
| **缓存/消息** | Redis, Kafka, RabbitMQ |
12691
| **服务治理** | Etcd, Consul, Nacos, Jaeger, Prometheus, OpenTelemetry |
12792
| **其他** | DTM (分布式事务), WebSocket, Swagger, PProf |
93+
| ... | ... |
12894

12995
👉 [**查看完整的技术栈与组件列表**](https://go-sponge.com/zh/component/)。
13096

0 commit comments

Comments
 (0)