diff --git a/contributing.md b/contributing.md index 0c6a7d4a6b..6206d59f51 100644 --- a/contributing.md +++ b/contributing.md @@ -16,6 +16,7 @@ | [日本語](docs/contributing/contributing_ja.md) | [हिंदी](docs/contributing/contributing_hi.md) | [Dutch](docs/contributing/contributing_nl.md) +| [فارسی](docs/contributing/contributing_fa.md) ## Let's make Bruno better, together!! @@ -74,6 +75,7 @@ npm run build:bruno-filestore # bundle js sandbox libraries npm run sandbox:bundle-libraries --workspace=packages/bruno-js ``` + ##### Option 2 ```bash @@ -94,18 +96,22 @@ npm run dev:electron ``` ##### Option 2 + ```bash # run electron and react app concurrently npm run dev ``` #### Customize Electron `userData` path + If `ELECTRON_USER_DATA_PATH` env-variable is present and its development mode, then `userData` path is modified accordingly. e.g. + ```sh ELECTRON_USER_DATA_PATH=$(realpath ~/Desktop/bruno-test) npm run dev:electron ``` + This will create a `bruno-test` folder on your Desktop and use it as the `userData` path. ### Troubleshooting diff --git a/docs/contributing/contributing_fa.md b/docs/contributing/contributing_fa.md new file mode 100644 index 0000000000..5316a48a99 --- /dev/null +++ b/docs/contributing/contributing_fa.md @@ -0,0 +1,92 @@ +[English](../../contributing.md) + +## با هم، Bruno را بهتر می‌کنیم! + +خوشحالم که قصد دارید Bruno را بهبود ببخشید. در ادامه قوانین و راهنماها برای راه‌اندازی Bruno روی سیستم شما آورده شده است. + +### فناوری‌های استفاده‌شده + +به فارسی برونو Bruno با استفاده از Next.js و React ساخته شده است. همچنین از Electron برای بسته‌بندی نسخه دسکتاپ (که امکان مجموعه‌های محلی را فراهم می‌کند) استفاده می‌کنیم. + +کتابخانه‌هایی که استفاده می‌کنیم: + +- CSS - Tailwind استایل +- Codemirror - ویرایشگر کد +- Redux - مدیریت وضعیت +- Tabler Icons - آیکون‌ها +- formik - فرم‌ها +- Yup اعتبارسنجی اسکیمـا +- axios - کلاینت درخواست +- chokidar - پایش‌گر سیستم فایل + +### پیش‌نیازها + +شما به [نود v20.x یا اخرین نسخه پایدار](https://nodejs.org/en/) و npm 8.x نیاز دارید. در این پروژه از فضای کاری npm (npm workspaces) استفاده می‌کنیم. + +### شروع به کدنویسی + +برای راه‌اندازی محیط توسعه محلی به فایل [مستندات توسعه](docs/development_fa.md) مراجعه کنید: + +### ارسال Pull Request + +1 - لطفاً Pull Requestها (PR) را کوتاه و متمرکز نگه دارید و تنها یک هدف مشخص را دنبال کنند.
+2 - لطفاً از فرمت نام‌گذاری شاخه‌ها استفاده کنید: + +- feature/[name]: این شاخه باید شامل یک قابلیت مشخص باشد. + - feature/dark-mode : مثال +- bugfix/[name]: این شاخه باید تنها شامل رفع یک باگ مشخص باشد. + - bugfix/bug-1 : مثال + +## توسعه + +به فارسی برونو یا Bruno به‌صورت یک اپلیکیشن «سنگین» توسعه داده می‌شود. برای اجرا باید ابتدا Next.js را در یک پنجره ترمینال اجرا کنید و سپس اپلیکیشن Electron را در پنجره ترمینال دیگری راه‌اندازی نمایید. + +### نیازمندی توسعه + +- NodeJS v18 + +### اجرای محلی + +```bash +# از ورژن NodeJS 18 استفاده کنید +nvm use + +# نصب وابستگی‌ها +npm i --legacy-peer-deps + +# ساخت مستندات GraphQL +npm run build:graphql-docs + +# ساخت bruno-query +npm run build:bruno-query + +# اجرای اپ Next (ترمینال 1) +npm run dev:web + +# اجرای اپ Electron (ترمینال 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 +# اجرای تست‌های schema مربوط به bruno +npm test --workspace=packages/bruno-schema + +# اجرای تست‌ها در همه فضاهای کاری (در صورت وجود) +npm test --workspaces --if-present +``` diff --git a/docs/publishing/publishing_fa.md b/docs/publishing/publishing_fa.md new file mode 100644 index 0000000000..6d24240c8f --- /dev/null +++ b/docs/publishing/publishing_fa.md @@ -0,0 +1,8 @@ +[English](../../publishing.md) + +### انتشار Bruno در یک پکیج منیجر جدید + +اگرچه کد ما متن‌باز است و همه می‌توانند از آن استفاده کنند، لطفاً قبل از انتشار Bruno در مدیر بسته‌های جدید با ما تماس بگیرید. به عنوان سازنده Bruno، علامت تجاری `Bruno` را برای این پروژه دارم و مایلم توزیع آن را مدیریت کنم. اگر دوست دارید Bruno را در یک مدیر بسته جدید ببینید، لطفاً یک issue در گیت‌هاب ثبت کنید. + +اگرچه بیشتر قابلیت‌های ما رایگان و متن‌باز هستند (شامل REST و GraphQL Apis)، +ما تلاش می‌کنیم بین اصول متن‌باز و توسعه پایدار تعادل مناسبی برقرار کنیم - https://github.com/usebruno/bruno/discussions/269 diff --git a/docs/readme/readme_fa.md b/docs/readme/readme_fa.md new file mode 100644 index 0000000000..3e495d4269 --- /dev/null +++ b/docs/readme/readme_fa.md @@ -0,0 +1,143 @@ +
+ + +### برونو یا Bruno - محیط توسعه متن باز برای تست و توسعه 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/tests.yml/badge.svg?branch=main)](https://github.com/usebruno/bruno/actions/workflows/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) +[![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](../../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) +| **فارسی** +| [Română](./readme_ro.md) +| [Polski](./readme_pl.md) +| [简体中文](./readme_cn.md) +| [正體中文](./readme_zhtw.md) +| [العربية](./readme_ar.md) +| [日本語](./readme_ja.md) +| [ქართული](./readme_ka.md) + +برونو یک کلاینت API جدید و نوآورانه است که هدفش تغییر وضعیت فعلی ابزارهایی مانند Postman و سایر ابزارهای مشابه است. + +برونو مجموعه‌های شما را مستقیماً در یک پوشه روی فایل‌سیستم شما ذخیره می‌کند. ما از یک زبان نشانه‌گذاری ساده به نام Bru برای ذخیره اطلاعات درخواست‌های API استفاده می‌کنیم. + +شما می‌توانید برای همکاری روی مجموعه‌های API خود، از Git یا هر سیستم کنترل نسخه دلخواهتان استفاده کنید. + +برونو فقط به صورت آفلاین کار می‌کند. هیچ برنامه‌ای برای اضافه کردن همگام‌سازی ابری به برونو در آینده وجود ندارد. ما به حریم خصوصی داده‌های شما اهمیت می‌دهیم و معتقدیم که باید روی دستگاه خودتان باقی بمانند. می‌توانید چشم‌انداز بلندمدت ما را مطالعه کنید. [اینجا (به انگلیسی)](https://github.com/usebruno/bruno/discussions/269) + +📢 جدیدترین ارائه ما را در کنفرانس India FOSS 3.0 تماشا کنید. +[اینجا](https://www.youtube.com/watch?v=7bSMFpbcPiY) + +![bruno](/assets/images/landing-2.png)

+ +### نصب + +برونو به صورت یک فایل باینری برای دانلود در دسترس است. [بر روی وبسایت ما](https://www.usebruno.com/downloads) برای مک لینکوس و ویندوز. + +همچنین می‌توانید برونو را از طریق مدیر بسته‌هایی مانند Homebrew، Chocolatey، Snap و Apt نصب کنید. + +```sh +# بر روی مک از طریق brew +brew install bruno + +# بر روی ویندوز از طریق Chocolatey +choco install bruno + +# بر روی لینوکس از طریق Snap +snap install bruno + +# بر روی لینوکس از طریق Apt +sudo mkdir -p /etc/apt/keyrings +sudo apt update && sudo apt install gpg curl +curl -fsSL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x9FA6017ECABE0266" \ + | gpg --dearmor \ + | sudo tee /etc/apt/keyrings/bruno.gpg > /dev/null +sudo chmod 644 /etc/apt/keyrings/bruno.gpg +echo "deb [arch=amd64 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 +``` + +### روی پلتفرم‌های مختلف کار می‌کند 🖥️ + +![bruno](/assets/images/run-anywhere.png)

+ +### همکاری از طریق گیت 👩‍💻🧑‍💻 + +یا هر سیستم کنترل نسخه‌ای که ترجیح می‌دهید + +![bruno](/assets/images/version-control.png)

+ +### لینک‌های مهم 📌 + +- [آخرین نسخه پایدار ما](https://github.com/usebruno/bruno/discussions/269) +- [نقشه راه](https://github.com/usebruno/bruno/discussions/384) +- [مستندات](https://docs.usebruno.com) +- [وبسایت](https://www.usebruno.com) +- [اشتراک ها](https://www.usebruno.com/pricing) +- [دانلود](https://www.usebruno.com/downloads) + +### ویدیوها 🎥 + +- [تجربه ها](https://github.com/usebruno/bruno/discussions/343) +- [مرکز دانش](https://github.com/usebruno/bruno/discussions/386) +- [اسکریپ مانیا](https://github.com/usebruno/bruno/discussions/385) + +### حمایت ❤️ + +جوون! اگر این پروژه را دوست دارید، روی دکمه ⭐ کلیک کنید! + +### تجربه‌های به اشتراک گذاشته‌شده 📣 + +اگر برونو به شما یا تیمتان کمک کرده است، لطفاً فراموش نکنید تجربه‌های خود را به اشتراک بگذارید. [تجربه‌های خود را در بحث گیت‌هاب ما به اشتراک بگذارید](https://github.com/usebruno/bruno/discussions/343). + +### انتشار برونو در یک پکیچ منیجر جدید + +لطفا چک بکنید [اینجارو](../../publishing.md) برای اطلاعات بیشتر. + +### مشارکت 👩‍💻🧑‍💻 + +خوشحالم که می‌خواهید برونو را بهتر کنید. لطفا [راهنمای مشارکت را بررسی کنید](../contributing/contributing_fa.md). + +حتی اگر نمی‌توانید از طریق کدنویسی مشارکت کنید، در گزارش باگ‌ها و درخواست قابلیت‌های جدید که به حل نیازهای شما کمک می‌کند تردید نکنید. + +### نویسنده ها + +
+ + + +
+ +### در ارتباط باشید 🌐 + +[𝕏 (تویتر)](https://twitter.com/use_bruno)
+[وبسایت](https://www.usebruno.com)
+[دیسکورد](https://discord.com/invite/KgcZUncpjq)
+[لینکدین](https://www.linkedin.com/company/usebruno) + +### برند + +**نام** + +به فارسی برونو - `Bruno` یک علامت تجاری ثبت‌شده متعلق به [Anoop M D](https://www.helloanoop.com/) + +**لوگو** + +لوگو توسط [OpenMoji](https://openmoji.org/library/emoji-1F436/) ساخته شده است. مجوز: CC [BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) + +### مجوز 📄 + +[MIT](../../license.md) diff --git a/publishing.md b/publishing.md index 458077b209..cfac639584 100644 --- a/publishing.md +++ b/publishing.md @@ -10,6 +10,7 @@ | [正體中文](docs/publishing/publishing_zhtw.md) | [日本語](docs/publishing/publishing_ja.md) | [Nederlands](docs/publishing/publishing_nl.md) +| [فارسی](docs/publishing/publishing_fa.md) ### Publishing Bruno to a new package manager diff --git a/readme.md b/readme.md index 8a1bad84cc..ea55920ed1 100644 --- a/readme.md +++ b/readme.md @@ -29,6 +29,7 @@ | [日本語](docs/readme/readme_ja.md) | [ქართული](docs/readme/readme_ka.md) | [Nederlands](docs/readme/readme_nl.md) +| [فارسی](docs/readme/readme_fa.md) Bruno is a new and innovative API client, aimed at revolutionizing the status quo represented by Postman and similar tools out there. @@ -52,6 +53,7 @@ We strive to strike a harmonious balance between [open-source principles and sus You can explore our [paid versions](https://www.usebruno.com/pricing) to see if there are additional features that you or your team may find useful!
## Table of Contents + - [Installation](#installation) - [Features](#features) - [Run across multiple platforms 🖥️](#run-across-multiple-platforms-%EF%B8%8F)