diff --git a/contributing.md b/contributing.md index 66c1da85a..310d9b210 100644 --- a/contributing.md +++ b/contributing.md @@ -1,5 +1,5 @@ **English** | [Українська](docs/contributing/contributing_ua.md) | [Русский](docs/contributing/contributing_ru.md) | [Türkçe](docs/contributing/contributing_tr.md) | [Deutsch](docs/contributing/contributing_de.md) | [Français](docs/contributing/contributing_fr.md) | [Português (BR)](docs/contributing/contributing_pt_br.md) | [বাংলা](docs/contributing/contributing_bn.md) | [Español](docs/contributing/contributing_es.md) | [Română](docs/contributing/contributing_ro.md) | [Polski](docs/contributing/contributing_pl.md) - + | [简体中文](docs/contributing/contributing_cn.md) ## Let's make bruno better, together !! We are happy that you are looking to improve bruno. Below are the guidelines to get started bringing up bruno on your computer. diff --git a/docs/contributing/contributing_cn.md b/docs/contributing/contributing_cn.md new file mode 100644 index 000000000..dd9b9c828 --- /dev/null +++ b/docs/contributing/contributing_cn.md @@ -0,0 +1,90 @@ +[English](/contributing.md) | [Українська](./contributing_ua.md) | [Русский](./contributing_ru.md) | [Türkçe](./contributing_tr.md) | [Deutsch](./contributing_de.md) | [Français](./contributing_fr.md) | [Português (BR)](./contributing_pt_br.md) | [বাংলা](./contributing_bn.md) | [Español](./contributing_es.md) | [Română](./contributing_ro.md) | [Polski](./contributing_pl.md) | **简体中文** + +## 让我们一起改进 Bruno！ + +很高兴看到您考虑改进 Bruno。以下是获取 Bruno 并在您的电脑上运行它的规则和指南。 + +### 使用的技术 + +Bruno 基于 NextJs 和 React 构建。我们使用 Electron 来封装桌面版本。 + +我们使用的库包括： + +- CSS - Tailwind +- 代码编辑器 - Codemirror +- 状态管理 - Redux +- 图标 - Tabler Icons +- 表单 - formik +- 模式验证 - Yup +- 请求客户端 - axios +- 文件系统监视器 - chokidar + +### 依赖项 + +您需要 [Node v18.x 或最新的 LTS 版本](https://nodejs.org/en/) 和 npm 8.x。我们在这个项目中也使用 npm 工作区（_npm workspaces_）。 + + +## 开发 + +Bruno 是作为一个 _client lourd（重客户端）_ 应用程序开发的。您需要在一个终端中启动 nextjs 来加载应用程序，然后在另一个终端中启动 Electron 应用程序。 + +### 依赖项 + +- NodeJS v18 + +### 本地开发 + +```bash +# 使用 node 版本 18 +nvm use + +# 安装依赖项 +npm i --legacy-peer-deps + +# 构建 graphql 文档 +npm run build:graphql-docs + +# 构建 bruno 查询 +npm run build:bruno-query + +# 启动 next（终端 1） +npm run dev:web + +# 启动重客户端（终端 2） +npm run dev:electron +``` + +### 故障排除 + +在运行 npm install 时，您可能会遇到 Unsupported platform 错误。为了解决这个问题，请删除 node_modules 目录和 package-lock.json 文件，然后再次运行 npm install。这应该会安装运行应用程序所需的所有包。 + +```shell +# 删除子目录中的 node_modules 目录 +find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do + rm -rf "$dir" +done + +# 删除子目录中的 package-lock.json 文件 +find . -type f -name "package-lock.json" -delete +``` + + +### 测试 + +```bash +# bruno-schema +npm test --workspace=packages/bruno-schema + +# bruno-lang +npm test --workspace=packages/bruno-lang +``` + + +### 提交 Pull Request + +- 请保持 PR 精简并专注于单一目标 +- 请遵循分支命名格式： + - feature/[feature name]：该分支应包含特定功能 + - 例如：feature/dark-mode + - bugfix/[bug name]：该分支应仅包含特定 bug 的修复 + - 例如：bugfix/bug-1 \ No newline at end of file diff --git a/docs/readme/readme_cn.md b/docs/readme/readme_cn.md new file mode 100644 index 000000000..506dbe9f0 --- /dev/null +++ b/docs/readme/readme_cn.md @@ -0,0 +1,131 @@ +
+ + +### Bruno - 开源IDE，用于探索和测试API。 + +[![GitHub version](https://badge.fury.io/gh/usebruno%2Fbruno.svg)](https://badge.fury.io/gh/usebruno%bruno) +[![CI](https://github.com/usebruno/bruno/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/usebruno/bruno/workflows/unit-tests.yml) +[![Commit Activity](https://img.shields.io/github/commit-activity/m/usebruno/bruno)](https://github.com/usebruno/bruno/pulse) +[![X](https://img.shields.io/twitter/follow/use_bruno?style=social&logo=x)](https://twitter.com/use_bruno) +[![网站](https://img.shields.io/badge/Website-Visit-blue)](https://www.usebruno.com) +[![下载](https://img.shields.io/badge/Download-Latest-brightgreen)](https://www.usebruno.com/downloads) + +[English](../../readme.md) | [Українська](./readme_ua.md) | [Русский](./readme_ru.md) | [Türkçe](./readme_tr.md) | [Deutsch](./readme_de.md) | [Français](./readme_fr.md) | [Português (BR)](./readme_pt_br.md) | [한국어](./readme_kr.md) | [বাংলা](./readme_bn.md) | [Español](./readme_es.md) | [Italiano](./readme_it.md) | [Română](./readme_ro.md) | [Polski](./readme_pl.md) | [简体中文](./readme_cn.md) + + +Bruno 是一款全新且创新的 API 客户端，旨在颠覆 Postman 和其他类似工具。 + +Bruno 直接在您的电脑文件夹中存储您的 API 信息。我们使用纯文本标记语言 Bru 来保存有关 API 的信息。 + +您可以使用 Git 或您选择的任何版本控制系统来对您的API信息进行版本控制和协作。 + +Bruno 仅限离线使用。我们计划永不向 Bruno 添加云同步功能。我们重视您的数据隐私，并认为它应该留在您的设备上。阅读我们的长期愿景 [点击查看](https://github.com/usebruno/bruno/discussions/269) + + +📢 观看我们在印度 FOSS 3.0 会议上的最新演讲 [点击查看](https://www.youtube.com/watch?v=7bSMFpbcPiY) + +![bruno](../../assets/images/landing-2.png)

+ +### 安装 + +Bruno 可以在我们的 [网站上下载](https://www.usebruno.com/downloads) Mac、Windows 和 Linux 的可执行文件。 + +您也可以通过包管理器如 Homebrew、Chocolatey、Scoop、Snap 和 Apt 安装 Bruno。 + +```sh +# 在 Mac 电脑上用 Homebrew 安装 +brew install bruno + +# 在 Windows 上用 Chocolatey 安装 +choco install bruno + +# 在 Windows 上用 Scoop 安装 +scoop bucket add extras +scoop install bruno + +# 在 Linux 上用 Snap 安装 +snap install bruno + +# 在 Linux 上用 Apt 安装 +sudo mkdir -p /etc/apt/keyrings +sudo gpg --no-default-keyring --keyring /etc/apt/keyrings/bruno.gpg --keyserver keyserver.ubuntu.com --recv-keys 9FA6017ECABE0266 + +echo "deb [signed-by=/etc/apt/keyrings/bruno.gpg] http://debian.usebruno.com/ bruno stable" | sudo tee /etc/apt/sources.list.d/bruno.list + +sudo apt update +sudo apt install bruno +``` + +### 在 Mac 上通过 Homebrew 安装 🖥️ + +![bruno](../../assets/images/run-anywhere.png)

+ +### Collaborate 安装 👩‍💻🧑‍💻 + +或者任何你选择的版本控制系统 + +![bruno](../../assets/images/version-control.png)

+ +### 重要链接 📌 + +- [我们的愿景](https://github.com/usebruno/bruno/discussions/269) +- [路线图](https://github.com/usebruno/bruno/discussions/384) +- [文档](https://docs.usebruno.com) +- [Stack Overflow](https://stackoverflow.com/questions/tagged/bruno) +- [网站](https://www.usebruno.com) +- [价格](https://www.usebruno.com/pricing) +- [下载](https://www.usebruno.com/downloads) +- [Github 赞助](https://github.com/sponsors/helloanoop). + +### 展示 🎥 + +- [Testimonials](https://github.com/usebruno/bruno/discussions/343) +- [Knowledge Hub](https://github.com/usebruno/bruno/discussions/386) +- [Scriptmania](https://github.com/usebruno/bruno/discussions/385) + +### 支持 ❤️ + +如果您喜欢 Bruno 并想支持我们的开源工作，请考虑通过 [Github Sponsors](https://github.com/sponsors/helloanoop) 来赞助我们。 + +### 分享评价 📣 + +如果 Bruno 在您的工作和团队中帮助了您，请不要忘记在我们的 GitHub 讨论上分享您的 [评价](https://github.com/usebruno/bruno/discussions/343) + +### 发布到新的包管理器 + +有关更多信息，请参见 [此处](../../publishing.md) 。 + +### 贡献 👩‍💻🧑‍💻 + +我很高兴您希望改进bruno。请查看 [贡献指南](../../contributing.md)。 + +即使您无法通过代码做出贡献，我们仍然欢迎您提出BUG和新的功能需求。 + +### 作者 + +
+ + + +
+ +### 联系方式 🌐 + +[𝕏 (Twitter)](https://twitter.com/use_bruno)
+[Website](https://www.usebruno.com)
+[Discord](https://discord.com/invite/KgcZUncpjq)
+[LinkedIn](https://www.linkedin.com/company/usebruno) + +### 商标 + +**名称** + +`Bruno` 是由 [Anoop M D](https://www.helloanoop.com/) 持有的商标。 + +**Logo** + +Logo 源自 [OpenMoji](https://openmoji.org/library/emoji-1F436/). License: CC [BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) + +### 许可证 📄 + +[MIT](../../license.md) diff --git a/readme.md b/readme.md index cee703e06..a7af313b0 100644 --- a/readme.md +++ b/readme.md @@ -10,7 +10,7 @@ [![Website](https://img.shields.io/badge/Website-Visit-blue)](https://www.usebruno.com) [![Download](https://img.shields.io/badge/Download-Latest-brightgreen)](https://www.usebruno.com/downloads) -**English** | [Українська](docs/readme/readme_ua.md) | [Русский](docs/readme/readme_ru.md) | [Türkçe](docs/readme/readme_tr.md) | [Deutsch](docs/readme/readme_de.md) | [Français](docs/readme/readme_fr.md) | [Português (BR)](docs/readme/readme_pt_br.md) | [한국어](docs/readme/readme_kr.md) | [বাংলা](docs/readme/readme_bn.md) | [Español](docs/readme/readme_es.md) | [Italiano](docs/readme/readme_it.md) | [Română](docs/readme/readme_ro.md) | [Polski](docs/readme/readme_pl.md) +**English** | [Українська](docs/readme/readme_ua.md) | [Русский](docs/readme/readme_ru.md) | [Türkçe](docs/readme/readme_tr.md) | [Deutsch](docs/readme/readme_de.md) | [Français](docs/readme/readme_fr.md) | [Português (BR)](docs/readme/readme_pt_br.md) | [한국어](docs/readme/readme_kr.md) | [বাংলা](docs/readme/readme_bn.md) | [Español](docs/readme/readme_es.md) | [Italiano](docs/readme/readme_it.md) | [Română](docs/readme/readme_ro.md) | [Polski](docs/readme/readme_pl.md) | [简体中文](docs/readme/readme_cn.md) Bruno is a new and innovative API client, aimed at revolutionizing the status quo represented by Postman and similar tools out there.