Merge pull request #652 from mvmn/main

Ukrainian translation of the documentation
2023-10-18 10:44:17 +05:30 · 2023-10-18 10:44:17 +05:30 · 9bd7723c48
commit 9bd7723c48
parent d809a58deb edbe9ee4f0
9 changed files with 178 additions and 6 deletions
--- a/contributing.md
+++ b/contributing.md
@ -1,4 +1,4 @@
-**English** | [Русский](/contributing_ru.md)
+**English** | [Українська](/contributing_ua.md) | [Русский](/contributing_ru.md)

 ## Lets make bruno better, together !!

--- a/contributing_ru.md
+++ b/contributing_ru.md
@ -1,4 +1,4 @@
-[English](/contributing.md) | **Русский**
+[English](/contributing.md) | [Українська](/contributing_ua.md) | **Русский**

 ## Давайте вместе сделаем Бруно лучше!!!

--- a/contributing_ua.md
+++ b/contributing_ua.md
@ -0,0 +1,37 @@
+[English](/contributing.md) | **Українська** | [Русский](/contributing_ru.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 workspaces в цьому проекті
+
+### Починаєм писати код
+
+Будь ласка, зверніться до [development_ua.md](docs/development_ua.md) за інструкціями щодо запуску локального середовища розробки.
+
+### Створення Pull Request-ів
+
+- Будь ласка, робіть PR-и маленькими і сфокусованими на одній речі
+- Будь ласка, слідуйте формату назв гілок
+  - feature/[назва feature]: Така гілка має містити зміни лише щодо конкретної feature
+    - Приклад: feature/dark-mode
+  - bugfix/[назва баґу]: Така гілка має містити лише виправлення конкретного багу
+    - Приклад: bugfix/bug-1
--- a/docs/development.md
+++ b/docs/development.md
@ -1,4 +1,4 @@
-**English** | [Русский](/docs/development_ru.md)
+**English** | [Українська](/docs/development_ua.md) | [Русский](/docs/development_ru.md)

 ## Development

--- a/docs/development_ru.md
+++ b/docs/development_ru.md
@ -1,4 +1,4 @@
-[English](/docs/development.md) | **Русский**
+[English](/docs/development.md) | [Українська](/docs/development_ua.md) | **Русский**

 ## Разработка

--- a/docs/development_ua.md
+++ b/docs/development_ua.md
@ -0,0 +1,55 @@
+[English](/docs/development.md) | **Українська** | [Русский](/docs/development_ru.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
+
+# запустіть додаток електрон (термінал 2)
+npm run dev:electron
+```
+
+### Усунення несправностей
+
+Ви можете зтикнутись із помилкою `Unsupported platform` коли запускаєте `npm install`. Щоб усунути цю проблему, вам потрібно видалити `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
+```
--- 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** | [Русский](/readme_ru.md)
+**English** | [Українська](/readme_ua.md) | [Русский](/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.

--- a/readme_ru.md
+++ b/readme_ru.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](/readme.md) | **Русский**
+[English](/readme.md) | [Українська](/readme_ua.md) | **Русский**

 Bruno - новый и инновационный клиент API, направленный на революцию в установившейся ситуации, представленной Postman и подобными инструментами.

--- a/readme_ua.md
+++ b/readme_ua.md
@ -0,0 +1,80 @@
+<br />
+<img src="assets/images/logo-transparent.png" width="80"/>
+
+### 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) | **Українська** | [Русский](/readme_ru.md)
+
+Bruno це новий та іноваційний API клієнт, націлений на революційну зміну статус кво, запровадженого інструментами на кшталт Postman.
+
+Bruno зберігає ваші колекції напряму у теці на вашому диску. Він використовує текстову мову розмітки Bru для збереження інформації про ваші API запити.
+
+Ви можете використовувати git або будь-яку іншу систему контролю версій щоб спільно працювати над вашими колекціями API запитів.
+
+Bruno є повністю автономним. Немає жодних планів додавати будь-які синхронізації через хмару, ніколи. Ми цінуємо приватність ваших даних, і вважаєм, що вони мають залишитись лише на вашому комп'ютері. Взнати більше про наше бачення у довготривалій перспективі можна [тут](https://github.com/usebruno/bruno/discussions/269)
+
+![bruno](assets/images/landing-2.png) <br /><br />
+
+### Кросплатформенність 🖥️
+
+![bruno](assets/images/run-anywhere.png) <br /><br />
+
+### Спільна робота через Git 👩‍💻🧑‍💻
+
+Або будь-яку іншу систему контролю версій на ваш вибір
+
+![bruno](assets/images/version-control.png) <br /><br />
+
+### Важливі посилання 📌
+
+- [Наше бачення довготривалої перспективи проекту](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/downloads)
+
+### Вітрина 🎥
+
+- [Відгуки](https://github.com/usebruno/bruno/discussions/343)
+- [Хаб знань](https://github.com/usebruno/bruno/discussions/386)
+- [Scriptmania](https://github.com/usebruno/bruno/discussions/385)
+
+### Підтримка ❤️
+
+Гав! Якщо вам сподобався проект, тисніть на ⭐ !!
+
+### Поділитись відгуками 📣
+
+Якщо Bruno допоміг вам у вашій роботі і вашим командам, будь ласка не забудьте поділитись вашими [відгуками у github дискусії](https://github.com/usebruno/bruno/discussions/343)
+
+### Зробити свій внесок 👩‍💻🧑‍💻
+
+Я радий що ви бажаєте покращити Bruno. Будь ласка переглянте [інструкцію по контрибуції](contributing_ua.md)
+
+Навіть якщо ви не можете зробити свій внесок пишучи програмний код, будь ласка не соромтесь рапортувати про помилки і писати запити на новий функціонал, який потрібен вам у вашій роботі.
+
+### Автори
+
+<div align="center">
+    <a href="https://github.com/usebruno/bruno/graphs/contributors">
+        <img src="https://contrib.rocks/image?repo=usebruno/bruno" />
+    </a>
+</div>
+
+### Залишайтесь на зв'язку 🌐
+
+[Twitter](https://twitter.com/use_bruno) <br />
+[Сайт](https://www.usebruno.com) <br />
+[Discord](https://discord.com/invite/KgcZUncpjq)
+[LinkedIn](https://www.linkedin.com/company/usebruno)
+
+### Ліцензія 📄
+
+[MIT](license.md)