docs: make Chinese README the default

2026-07-13 10:13:17 +00:00
parent 1f946588f2
commit d2160137ad
1 changed files with 62 additions and 56 deletions
@@ -1,3 +1,9 @@
+<!-- WEHUB_ZH_README -->
+> [!NOTE]
+> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。  
+> [English](./README.en.md) · [原始项目](https://github.com/InsForge/InsForge) · [上游 README](https://github.com/InsForge/InsForge/blob/HEAD/README.md)  
+> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
+
 <div align="center">
  <a href="https://insforge.dev">
    <picture>
@@ -8,7 +14,7 @@
  </a>

  <p>
-    The all-in-one, open-source backend platform for agentic coding.<br />
+    面向智能体编程（agentic coding）的一体化开源后端平台。<br />
  </p>

  <p>
@@ -35,25 +41,25 @@
 </div>

 <p align="center">
-  ⭐ <em>Help us reach more developers and grow the InsForge community. Star this repo!</em>
+  ⭐ <em>帮助我们触达更多开发者并壮大 InsForge 社区。请为本仓库点亮 Star！</em>
 </p>

 ## InsForge
-The all-in-one, open-source backend platform for agentic coding. InsForge gives your coding agent database, auth, storage, compute, hosting, and AI gateway to ship full-stack apps end-to-end.
+面向智能体编程（agentic coding）的一体化开源后端平台。InsForge 为你的编码智能体提供数据库、认证（auth）、存储、计算、托管和 AI 网关，助你端到端交付全栈应用。

 https://github.com/user-attachments/assets/345efbc6-ca63-4189-bde0-12ef3bda561b

-### How it works
+### 工作原理

-Coding agents interact with InsForge through one of two interfaces:
+编码智能体可通过以下两种接口之一与 InsForge 交互：

- **MCP Server** (self-hosted and cloud): exposes InsForge's operations as tools any MCP-compatible agent can call.
- **CLI + Skills** (cloud only): a command-line interface paired with Skills that agents invoke directly from the terminal.
+- **MCP Server**（自托管与云端）：将 InsForge 的操作暴露为工具，任何兼容 MCP 的智能体均可调用。
+- **CLI + Skills**（仅云端）：命令行界面，配合 Skills，供智能体在终端中直接调用。

-Both interfaces let coding agents operate the backend like backend engineers:
+两种接口都让编码智能体像后端工程师一样操作后端：

- **Read backend context and state**: Pull documentation, schemas, metadata (deployed functions, bucket contents, auth config), and runtime logs, so the agent has what it needs to write code, verify what it built, and debug when something breaks.
- **Configure primitives**: Deploy edge functions, run database migrations, create storage buckets, set up auth providers, and configure other backend resources directly.
+- **读取后端上下文与状态**：拉取文档、模式（schema）、元数据（已部署函数、存储桶内容、认证配置）以及运行时日志，让智能体具备编写代码、验证构建成果以及在出问题时进行调试所需的信息。
+- **配置基础能力**：直接部署边缘函数、运行数据库迁移、创建存储桶、设置认证提供方，并配置其他后端资源。

 ```mermaid
 graph TB
@@ -88,41 +94,41 @@ graph TB
    linkStyle default stroke:#30363d,stroke-width:1px
 ```

-### Core Products:
- **Authentication**: User management, authentication, and sessions
- **Database**: Postgres relational database
- **Storage**: S3 compatible file storage
- **Model Gateway**: OpenAI compatible API across multiple LLM providers
- **Edge Functions**: Serverless code running on the edge
- **Compute** (private preview): Long-running container services
- **Site Deployment**: Site build and deployment
+### 核心产品：
+- **Authentication**：用户管理、认证与会话
+- **Database**：Postgres 关系型数据库
+- **Storage**：兼容 S3 的文件存储
+- **Model Gateway**：跨多家 LLM 提供商的 OpenAI 兼容 API
+- **Edge Functions**：在边缘运行的无服务器代码
+- **Compute**（私有预览）：长期运行的容器服务
+- **Site Deployment**：站点构建与部署


-## ⭐️ Star the Repository
+## ⭐️ 为仓库点亮 Star

 <p align="center">
  <img src="assets/insforge-star.gif" alt="Star InsForge" width="100%">
 </p>

-If you find InsForge useful or interesting, a GitHub Star ⭐️ would be greatly appreciated.
+如果你觉得 InsForge 有用或有趣，非常欢迎点亮 GitHub Star ⭐️。

-## Quickstart
+## 快速开始

-### Cloud-hosted: [insforge.dev](https://insforge.dev)
+### 云端托管：[insforge.dev](https://insforge.dev)

 <a href="https://insforge.dev" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/insforge.dev-181818?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iMjQwIiBoZWlnaHQ9IjI0MCIgdmlld0JveD0iMCAwIDI0MCAyNDAiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHBhdGggZD0iTTI2LjExODQgMTAxLjZDMjMuMjkzOSA5OC43ODMzIDIzLjI5MzkgOTQuMjE2NiAyNi4xMTg0IDkxLjRMOTcuNzE2NyAyMEwyMDAgMjBMNzcuMjYgMTQyLjRDNzQuNDM1NSAxNDUuMjE3IDY5Ljg1NjIgMTQ1LjIxNyA2Ny4wMzE3IDE0Mi40TDI2LjExODQgMTAxLjZaIiBmaWxsPSJ3aGl0ZSIvPjxwYXRoIGQ9Ik0xNTUuMjUxIDc3LjM3NUwyMDAgMTIyVjIyNEwxMDQuMTA5IDEyOC4zNzVMMTU1LjI1MSA3Ny4zNzVaIiBmaWxsPSJ3aGl0ZSIvPjwvc3ZnPgo=&logoColor=white" alt="InsForge.dev"></a>

-### Self-hosted: Docker Compose
+### 自托管：Docker Compose

-Prerequisites: [Docker](https://www.docker.com/) + [Node.js](https://nodejs.org/)
+前置要求：[Docker](https://www.docker.com/) + [Node.js](https://nodejs.org/)

-#### 1. Setup
+#### 1. 安装配置

-You can run InsForge locally using Docker Compose. This will start a local InsForge instance on your machine.
+你可以使用 Docker Compose 在本地运行 InsForge。这会在你的机器上启动一个本地 InsForge 实例。

 [![Deploy on Docker][docker-btn]][docker-deploy]

-Or run from source:
+或从源码运行：
 ```bash
 # Run with Docker
 git clone https://github.com/InsForge/InsForge.git
@@ -131,26 +137,26 @@ cp .env.example .env
 docker compose -f docker-compose.prod.yml up
 ```

-#### 2. Connect InsForge MCP
+#### 2. 连接 InsForge MCP

-Open [http://localhost:7130](http://localhost:7130)
+打开 [http://localhost:7130](http://localhost:7130)

-Follow the steps to connect InsForge MCP Server
+按照步骤连接 InsForge MCP Server

 <div align="center">
  <img src="assets/connect.png" alt="Connect InsForge MCP" width="600">
 </div>

-#### 3. Verify installation
+#### 3. 验证安装

-To verify the connection, send the following prompt to your agent:
+要验证连接，请向你的智能体发送以下提示：
 ```
 I'm using InsForge as my backend platform, call InsForge MCP's fetch-docs tool to learn about InsForge instructions.
 ```

-#### 4. Running Multiple Projects
+#### 4. 运行多个项目

-You can run multiple InsForge projects on the same host by using different ports and project names.
+你可以在同一主机上通过使用不同端口和项目名称来运行多个 InsForge 项目。

 ```bash
 # Create a separate env file for each project
@@ -158,7 +164,7 @@ cp .env.example .env.project1
 cp .env.example .env.project2
 ```

-Edit `.env.project2` with different ports:
+编辑 `.env.project2`，使用不同端口：
 ```
 POSTGRES_PORT=5442
 POSTGREST_PORT=5440
@@ -167,58 +173,58 @@ AUTH_PORT=7231
 DENO_PORT=7233
 ```

-Start each project with a unique name:
+使用唯一名称启动每个项目：
 ```bash
 docker compose -f docker-compose.prod.yml --env-file .env.project1 -p project1 up -d
 docker compose -f docker-compose.prod.yml --env-file .env.project2 -p project2 up -d
 ```

-Each project gets its own isolated database, storage, and configuration. Manage them with:
+每个项目都会获得各自独立的数据库、存储和配置。使用以下命令管理它们：
 ```bash
 docker compose -f docker-compose.prod.yml --env-file .env.project1 -p project1 ps      # status
 docker compose -f docker-compose.prod.yml --env-file .env.project1 -p project1 logs -f  # logs
 docker compose -f docker-compose.prod.yml --env-file .env.project1 -p project1 down     # stop
 ```

-### One-click Deployment
+### 一键部署

-In addition to running InsForge locally, you can also launch InsForge using a pre-configured setup. This allows you to get up and running quickly with InsForge without installing Docker on your local machine.
+除了在本地运行 InsForge，你还可以通过预配置方案启动 InsForge。这样无需在本地安装 Docker，即可快速上手 InsForge。

 | Railway | Zeabur | Sealos |
 | --- | --- | --- |
-| [![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/insforge) | [![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/Q82M3Y) | [![Deploy on Sealos](https://sealos.io/Deploy-on-Sealos.svg)](https://sealos.io/products/app-store/insforge) |
+| [![在 Railway 上部署](https://railway.com/button.svg)](https://railway.com/deploy/insforge) | [![在 Zeabur 上部署](https://zeabur.com/button.svg)](https://zeabur.com/templates/Q82M3Y) | [![在 Sealos 上部署](https://sealos.io/Deploy-on-Sealos.svg)](https://sealos.io/products/app-store/insforge) |


-## Contributing
+## 贡献

-**Contributing**: If you're interested in contributing, you can check our guide here [CONTRIBUTING.md](CONTRIBUTING.md). We truly appreciate pull requests, all types of help are appreciated!
+**贡献**：如有兴趣参与贡献，可参阅我们的指南 [CONTRIBUTING.md](CONTRIBUTING.md)。我们非常欢迎 Pull Request（PR），任何形式的帮助都令人感激！

-**Support**: If you need any help or support, we're responsive on our [Discord channel](https://discord.com/invite/MPxwj5xVvW), and also feel free to email us [info@insforge.dev](mailto:info@insforge.dev) too!
+**支持**：如需帮助或支持，欢迎在 [Discord 频道](https://discord.com/invite/MPxwj5xVvW), 与我们交流，也可发邮件至 [info@insforge.dev](mailto:info@insforge.dev)！


-## Documentation & Support
+## 文档与支持

-### Documentation
- **[Official Docs](https://docs.insforge.dev/introduction)** - Comprehensive guides and API references
+### 文档
+- **[官方文档](https://docs.insforge.dev/introduction)** - 全面的指南与 API 参考

-### Community
- **[Discord](https://discord.com/invite/MPxwj5xVvW)** - Join our vibrant community
- **[Twitter](https://x.com/InsForge)** - Follow for updates and tips
+### 社区
+- **[Discord](https://discord.com/invite/MPxwj5xVvW)** - 加入我们的活跃社区
+- **[Twitter](https://x.com/InsForge)** - 关注以获取更新与技巧

-### Contact
- **Email**: info@insforge.dev
+### 联系方式
+- **Email**：info@insforge.dev

-## License
+## 许可证

-This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+本项目采用 Apache License 2.0 许可证——详情请参阅 [LICENSE](LICENSE) 文件。

 ---

 [![Star History Chart](https://api.star-history.com/svg?repos=InsForge/InsForge&type=Date)](https://www.star-history.com/#InsForge/InsForge&Date)

-## Badges
+## 徽章

-Show your project is built with InsForge.
+展示你的项目基于 InsForge 构建。

 ### Made with InsForge

@@ -277,7 +283,7 @@ Show your project is built with InsForge.
 ```


-<p align="center">⭐ <b>Star us on GitHub</b> to get notified about new releases!</p>
+<p align="center">⭐ <b>在 GitHub 上为我们 Star</b>，以便及时获知新版本发布！</p>

 <!-- LINK GROUPS -->