mirror of
https://github.com/zhufuyi/sponge.git
synced 2025-09-26 20:51:14 +08:00
docs: update README
This commit is contained in:
13
README.md
13
README.md
@@ -28,7 +28,7 @@ Sponge provides a one-stop project development solution, covering code generatio
|
|||||||
- **Standardized Best Practices**: Based on mature solutions from the Go community (Gin/gRPC/Protobuf, etc.), eliminating the hassle of technology selection.
|
- **Standardized Best Practices**: Based on mature solutions from the Go community (Gin/gRPC/Protobuf, etc.), eliminating the hassle of technology selection.
|
||||||
- **Minimal Learning Curve**: Get started quickly and focus on business logic through code generation and clear examples.
|
- **Minimal Learning Curve**: Get started quickly and focus on business logic through code generation and clear examples.
|
||||||
- **Ideal for Team Collaboration**: Unified project structure improves code maintainability.
|
- **Ideal for Team Collaboration**: Unified project structure improves code maintainability.
|
||||||
- **AI Collaboration**: Based on Sponge's standardized directory and file structure, it intelligently generates business logic code, significantly reducing manual coding and improving development efficiency and code consistency.
|
- **AI Collaborative Development**: Sponge’s built-in AI assistant understands directory and file structures, intelligently generates business logic code based on context, significantly reduces manual coding, and improves development efficiency and code consistency.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
@@ -113,11 +113,12 @@ Sponge provides an online experience for code generation: [**Code Generation**](
|
|||||||
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/en_sponge-ui.png">
|
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/en_sponge-ui.png">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Connect to the database, select table names.
|
- Steps for running and testing the project locally:
|
||||||
- Download Code: Get the complete code.
|
- **Fill in parameters**: Connect to the database and select the table name.
|
||||||
- Generate Swagger Docs: `make docs`.
|
- **Download code**: Obtain the complete project code.
|
||||||
- Run: `make run`.
|
- **Generate Swagger documentation**: Run the command `make docs`.
|
||||||
- Test: Access the Swagger documentation at `http://localhost:8080/swagger/index.html` in your browser to test the API.
|
- **Start the service**: Run the command `make run`.
|
||||||
|
- **API testing**: Open `http://localhost:8080/swagger/index.html` in the browser and use the Swagger UI to test APIs.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 169 KiB After Width: | Height: | Size: 177 KiB |
@@ -15,7 +15,7 @@ Sponge 提供一站式项目开发解决方案,涵盖代码生成、开发、
|
|||||||
- **标准化最佳实践**:基于 Go 社区成熟方案(Gin/gRPC/Protobuf 等),避免技术选型纠结。
|
- **标准化最佳实践**:基于 Go 社区成熟方案(Gin/gRPC/Protobuf 等),避免技术选型纠结。
|
||||||
- **极简学习曲线**:通过代码生成和清晰示例,快速上手,专注业务逻辑。
|
- **极简学习曲线**:通过代码生成和清晰示例,快速上手,专注业务逻辑。
|
||||||
- **适合团队协作**:统一项目结构,提升代码可维护性。
|
- **适合团队协作**:统一项目结构,提升代码可维护性。
|
||||||
- **AI协作**:基于 Sponge 规范目录与文件结构,智能生成业务逻辑代码,显著降低手工编码,提升开发效率与代码一致性。
|
- **AI 协作开发**:Sponge 内置 AI 助手感知目录与文件结构,根据上下文智能生成业务逻辑代码,显著降低手工编码,提升开发效率与代码一致性。
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
@@ -101,11 +101,12 @@ Sponge 提供在线体验生成代码:[**Code Generation**](https://go-sponge.
|
|||||||
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-ui.png">
|
<img width="1500px" src="https://raw.githubusercontent.com/go-dev-frame/sponge/main/assets/sponge-ui.png">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- 连接数据库,选择表名。
|
- 项目本地运行与测试步骤:
|
||||||
- 下载代码:得到完整代码。
|
- **填写参数**:连接数据库,选择表名。
|
||||||
- 生成 swagger 文档:`make docs`。
|
- **下载代码**:获取完整项目代码。
|
||||||
- 运行:`make run`。
|
- **生成 swagger 文档**:执行命令 `make docs`。
|
||||||
- 测试:在浏览器访问 swagger 文档 `http://localhost:8080/swagger/index.html` 测试 API。
|
- **启动服务**:执行命令 `make run`。
|
||||||
|
- **接口测试**:在浏览器中访问 `http://localhost:8080/swagger/index.html` 通过 Swagger 界面进行 API 测试。
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 163 KiB After Width: | Height: | Size: 168 KiB |
Reference in New Issue
Block a user