diff --git a/contributing.md b/contributing.md index a538f1bd7..abfcce4d3 100644 --- a/contributing.md +++ b/contributing.md @@ -1,3 +1,5 @@ +**English** | [Русский](/contributing_ru.md) + ## Lets make bruno better, together !! I am happy that you are looking to improve bruno. Below are the guidelines to get started bringing up bruno on your computer. diff --git a/contributing_ru.md b/contributing_ru.md new file mode 100644 index 000000000..316408162 --- /dev/null +++ b/contributing_ru.md @@ -0,0 +1,37 @@ +[English](/contributing.md) | **Русский** + +## Давайте вместе сделаем Бруно лучше!!! + +Я рад, что Вы хотите усовершенствовать 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 + +### Приступим к коду + +Пожалуйста, обратитесь к [development_ru.md](docs/development_ru.md) для получения инструкций по запуску локальной среды разработки. + +### Создание Pull Request + +- Пожалуйста, пусть PR будет небольшим и сфокусированным на одной вещи +- Пожалуйста, соблюдайте формат создания веток + - feature/[название функции]: Эта ветка должна содержать изменения для конкретной функции + - Пример: feature/dark-mode + - bugfix/[название ошибки]: Эта ветка должна содержать только исправления для конкретной ошибки + - Пример bugfix/bug-1 \ No newline at end of file diff --git a/docs/development.md b/docs/development.md index 77614d2f6..c1c402e08 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,3 +1,5 @@ +**English** | [Русский](/docs/development_ru.md) + ## Development Bruno is being developed as a desktop app. You need to load the app by running the nextjs app in one terminal and then run the electron app in another terminal. diff --git a/docs/development_ru.md b/docs/development_ru.md new file mode 100644 index 000000000..4d4e3a80e --- /dev/null +++ b/docs/development_ru.md @@ -0,0 +1,55 @@ +[English](/docs/development.md) | **Русский** + +## Разработка + +Bruno разрабатывается как десктопное приложение. Необходимо загрузить приложение, запустив приложение nextjs в одном терминале, а затем запустить приложение 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 в подкаталогах +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 +``` diff --git a/readme.md b/readme.md index 651d8cebe..29cb5ad93 100644 --- a/readme.md +++ b/readme.md @@ -6,10 +6,12 @@ [![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) -[![Twitter](https://img.shields.io/twitter/follow/use_bruno?style=social&logo=twitter)](https://twitter.com/use_bruno) +[![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_ru.md) + Bruno is a new and innovative API client, aimed at revolutionizing the status quo represented by Postman and similar tools out there. Bruno stores your collections directly in a folder on your filesystem. We use a plain text markup language, Bru, to save information about API requests. diff --git a/readme_ru.md b/readme_ru.md new file mode 100644 index 000000000..8c25e5c57 --- /dev/null +++ b/readme_ru.md @@ -0,0 +1,79 @@ +
+ + +### 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) +[![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) | **Русский** + +Bruno - новый и инновационный клиент API, направленный на революцию в установившейся ситуации, представленной Postman и подобными инструментами. + +Bruno хранит ваши коллекции непосредственно в папке в вашей файловой системе. Для сохранения информации об API-запросах мы используем язык Bru. + +Для совместной работы над коллекциями API можно использовать git или любой другой контроль версий по вашему выбору. + +Bruno работает только в автономном режиме. Добавление облачной синхронизации в Bruno не планируется. Мы ценим конфиденциальность ваших данных и считаем, что они должны оставаться на вашем устройстве. Ознакомьтесь с нашим долгосрочным видением [здесь](https://github.com/usebruno/bruno/discussions/269) + +![bruno](assets/images/landing-2.png)

+ +### Работа на нескольких платформах 🖥️ + +![bruno](assets/images/run-anywhere.png)

+ +### Совместная работа через Git 👩‍💻🧑‍💻 + +Или другая система контроля версий по вашему выбору + +![bruno](assets/images/version-control.png)

+ +### Важные ссылки 📌 + +- [Наше долгосрочное видение](https://github.com/usebruno/bruno/discussions/269) +- [Roadmap](https://github.com/usebruno/bruno/discussions/384) +- [Документация](https://docs.usebruno.com) +- [Сайт](https://www.usebruno.com) +- [Скачать Bruno](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) + +### Поддержка ❤️ + +Гав! Если вам нравится проект, нажмите на звездочку ⭐ !!! + +### Поделись отзывами 📣 + +Если Бруно помог вам в работе и в ваших командах, пожалуйста, не забудьте поделиться своим [отзывом на нашем обсуждении в github](https://github.com/usebruno/bruno/discussions/343) + +### Внести вклад 👩‍💻🧑‍💻 + +Я рад, что Вы хотите улучшить Бруно. Пожалуйста, ознакомьтесь с [этим гайдом](contributing_ru.md) + +Даже если вы не можете внести свой вклад с помощью кода, пожалуйста, не стесняйтесь сообщать об ошибках и пожеланиях к функциям, которые необходимо реализовать для решения вашей задачи. + +### Авторы + +
+ + + +
+ +### Оставайтесь на связи 🌐 + +[X ( Twitter )](https://twitter.com/use_bruno)
+[Наш сайт](https://www.usebruno.com)
+[Discord](https://discord.com/invite/KgcZUncpjq) + +### Лицензия 📄 + +[MIT](license.md)