Merge pull request #788 from areebniyas/feature/restructure-folders

Restructure and merge documentation files

contributing.md

@@ -35,3 +35,57 @@ Please reference [development.md](docs/development.md) for instructions on runni
     - Example: feature/dark-mode
   - bugfix/[bug name]: This branch should contain only bug fixes for a specific bug
     - Example bugfix/bug-1
+
+## Development
+
+Bruno is being developed as a desktop app. You need to load the app by running the Next.js app in one terminal and then run the electron app in another terminal.
+
+### Dependencies
+
+- NodeJS v18
+
+### Local Development
+
+```bash
+# use nodejs 18 version
+nvm use
+
+# install deps
+npm i --legacy-peer-deps
+
+# build graphql docs
+npm run build:graphql-docs
+
+# build bruno query
+npm run build:bruno-query
+
+# run next app (terminal 1)
+npm run dev:web
+
+# run electron app (terminal 2)
+npm run dev:electron
+```
+
+### Troubleshooting
+
+You might encounter a `Unsupported platform` error when you run `npm install`. To fix this, you will need to delete `node_modules` and `package-lock.json` and run `npm install`. This should install all the necessary packages needed to run the app.
+
+```shell
+# Delete node_modules in sub-directories
+find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do
+  rm -rf "$dir"
+done
+
+# Delete package-lock in sub-directories
+find . -type f -name "package-lock.json" -delete
+```
+
+### Testing
+
+```bash
+# bruno-schema
+npm test --workspace=packages/bruno-schema
+
+# bruno-lang
+npm test --workspace=packages/bruno-lang
+```

docs/contributing/contributing_de.md

@@ -35,3 +35,57 @@ Eine Anleitung zum Ausführen einer lokalen Entwicklungsumgebung findest Du in [
     - Beispiel: feature/dark-mode
   - bugfix/[bug name]: Dieser Branch soll ausschließlich Bugfixes für einen bestimmten Bug enthalten
     - Beispiel: bugfix/bug-1
+
+## Entwicklung
+
+Bruno wird als Desktop-Anwendung entwickelt. Um die App zu starten, musst Du zuerst die Next.js App in einem Terminal ausführen und anschließend in einem anderen Terminal die Electron-App.
+
+### Abhängigkeiten
+
+- NodeJS v18
+
+### Lokales Entwickeln
+
+```bash
+# use nodejs 18 version
+nvm use
+
+# install deps
+npm i --legacy-peer-deps
+
+# build graphql docs
+npm run build:graphql-docs
+
+# build bruno query
+npm run build:bruno-query
+
+# run next app (terminal 1)
+npm run dev:web
+
+# run electron app (terminal 2)
+npm run dev:electron
+```
+
+### Troubleshooting
+
+Es kann sein, dass Du einen `Unsupported platform`-Fehler bekommst, wenn Du `npm install` ausführst. Um dies zu beheben, musst Du `node_modules` und `package-lock.json` löschen und `npm install` erneut ausführen. Dies sollte alle notwendigen Pakete installieren, die zum Ausführen der Anwendung benötigt werden.
+
+```shell
+# Delete node_modules in sub-directories
+find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do
+  rm -rf "$dir"
+done
+
+# Delete package-lock in sub-directories
+find . -type f -name "package-lock.json" -delete
+```
+
+### Testen
+
+```bash
+# bruno-schema
+npm test --workspace=packages/bruno-schema
+
+# bruno-lang
+npm test --workspace=packages/bruno-lang
+```

docs/contributing/contributing_fr.md

@@ -35,3 +35,57 @@ Veuillez vous référez à la [documentation de développement](docs/development
     - Exemple: feature/dark-mode
   - bugfix/[bug name]: Cette branche devrait contenir seulement une solution pour pour une bogue spécifique
     - Exemple: bugfix/bug-1
+
+## Développement
+
+Bruno est développé comme une application de _lourde_. Vous devez charger l'application en démarrant nextjs dans un terminal, puis démarre l'application Electron dans un autre terminal.
+
+### Dépendances
+
+- NodeJS v18
+
+### Développement local
+
+```bash
+# use nodejs 18 version
+nvm use
+
+# install deps
+npm i --legacy-peer-deps
+
+# build graphql docs
+npm run build:graphql-docs
+
+# build bruno query
+npm run build:bruno-query
+
+# run next app (terminal 1)
+npm run dev:web
+
+# run electron app (terminal 2)
+npm run dev:electron
+```
+
+### Dépannage
+
+Vous pourriez rencontrer une error  `Unsupported platform` pendant le lancement de `npm install`. Pour résoudre cela, veuillez supprimer le répertoire `node_modules`, le fichier `package-lock.json` et lancer à nouveau `npm install`. Cela devrait isntaller tous les paquets nécessaires pour lancer l'application.
+
+```shell
+# Delete node_modules in sub-directories
+find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do
+  rm -rf "$dir"
+done
+
+# Delete package-lock in sub-directories
+find . -type f -name "package-lock.json" -delete
+```
+
+### Tests
+
+```bash
+# bruno-schema
+npm test --workspace=packages/bruno-schema
+
+# bruno-lang
+npm test --workspace=packages/bruno-lang
+```

docs/contributing/contributing_ru.md

@@ -35,3 +35,57 @@ Bruno построен с использованием Next.js и React. Мы т
     - Пример: feature/dark-mode
   - bugfix/[название ошибки]: Эта ветка должна содержать только исправления для конкретной ошибки
     - Пример 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 в подкаталогах
+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
+```

docs/contributing/contributing_ua.md

@@ -35,3 +35,57 @@ Bruno побудований на Next.js та React. Також для деск
     - Приклад: feature/dark-mode
   - bugfix/[назва баґу]: Така гілка має містити лише виправлення конкретного багу
     - Приклад: 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
+
+# запустіть додаток електрон (термінал 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
+```

docs/development.md

@@ -1,55 +0,0 @@
-**English** | [Українська](/docs/development_ua.md) | [Русский](/docs/development_ru.md) | [Deutsch](/docs/development_de.md) | [Français](/docs/development_fr.md)
-
-## Development
-
-Bruno is being developed as a desktop app. You need to load the app by running the Next.js app in one terminal and then run the electron app in another terminal.
-
-### Dependencies
-
-- NodeJS v18
-
-### Local Development
-
-```bash
-# use nodejs 18 version
-nvm use
-
-# install deps
-npm i --legacy-peer-deps
-
-# build graphql docs
-npm run build:graphql-docs
-
-# build bruno query
-npm run build:bruno-query
-
-# run next app (terminal 1)
-npm run dev:web
-
-# run electron app (terminal 2)
-npm run dev:electron
-```
-
-### Troubleshooting
-
-You might encounter a `Unsupported platform` error when you run `npm install`. To fix this, you will need to delete `node_modules` and `package-lock.json` and run `npm install`. This should install all the necessary packages needed to run the app.
-
-```shell
-# Delete node_modules in sub-directories
-find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do
-  rm -rf "$dir"
-done
-
-# Delete package-lock in sub-directories
-find . -type f -name "package-lock.json" -delete
-```
-
-### Testing
-
-```bash
-# bruno-schema
-npm test --workspace=packages/bruno-schema
-
-# bruno-lang
-npm test --workspace=packages/bruno-lang
-```

docs/development_de.md

@@ -1,55 +0,0 @@
-[English](/docs/development.md) | [Українська](/docs/development_ua.md) | [Русский](/docs/development_ru.md) | **Deutsch** | [Français](/docs/development_fr.md)
-
-## Entwicklung
-
-Bruno wird als Desktop-Anwendung entwickelt. Um die App zu starten, musst Du zuerst die Next.js App in einem Terminal ausführen und anschließend in einem anderen Terminal die Electron-App.
-
-### Abhängigkeiten
-
-- NodeJS v18
-
-### Lokales Entwickeln
-
-```bash
-# use nodejs 18 version
-nvm use
-
-# install deps
-npm i --legacy-peer-deps
-
-# build graphql docs
-npm run build:graphql-docs
-
-# build bruno query
-npm run build:bruno-query
-
-# run next app (terminal 1)
-npm run dev:web
-
-# run electron app (terminal 2)
-npm run dev:electron
-```
-
-### Troubleshooting
-
-Es kann sein, dass Du einen `Unsupported platform`-Fehler bekommst, wenn Du `npm install` ausführst. Um dies zu beheben, musst Du `node_modules` und `package-lock.json` löschen und `npm install` erneut ausführen. Dies sollte alle notwendigen Pakete installieren, die zum Ausführen der Anwendung benötigt werden.
-
-```shell
-# Delete node_modules in sub-directories
-find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do
-  rm -rf "$dir"
-done
-
-# Delete package-lock in sub-directories
-find . -type f -name "package-lock.json" -delete
-```
-
-### Testen
-
-```bash
-# bruno-schema
-npm test --workspace=packages/bruno-schema
-
-# bruno-lang
-npm test --workspace=packages/bruno-lang
-```

docs/development_fr.md

@@ -1,55 +0,0 @@
-[English](/docs/development.md) | [Українська](/docs/development_ua.md) | [Русский](/docs/development_ru.md) | [Deutsch](/docs/development_de.md) | **Français**
-
-## Développement
-
-Bruno est développé comme une application de _lourde_. Vous devez charger l'application en démarrant nextjs dans un terminal, puis démarre l'application Electron dans un autre terminal.
-
-### Dépendances
-
-- NodeJS v18
-
-### Développement local
-
-```bash
-# use nodejs 18 version
-nvm use
-
-# install deps
-npm i --legacy-peer-deps
-
-# build graphql docs
-npm run build:graphql-docs
-
-# build bruno query
-npm run build:bruno-query
-
-# run next app (terminal 1)
-npm run dev:web
-
-# run electron app (terminal 2)
-npm run dev:electron
-```
-
-### Dépannage
-
-Vous pourriez rencontrer une error  `Unsupported platform` pendant le lancement de `npm install`. Pour résoudre cela, veuillez supprimer le répertoire `node_modules`, le fichier `package-lock.json` et lancer à nouveau `npm install`. Cela devrait isntaller tous les paquets nécessaires pour lancer l'application.
-
-```shell
-# Delete node_modules in sub-directories
-find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do
-  rm -rf "$dir"
-done
-
-# Delete package-lock in sub-directories
-find . -type f -name "package-lock.json" -delete
-```
-
-### Tests
-
-```bash
-# bruno-schema
-npm test --workspace=packages/bruno-schema
-
-# bruno-lang
-npm test --workspace=packages/bruno-lang
-```

docs/development_ru.md

@@ -1,55 +0,0 @@
-[English](/docs/development.md) | [Українська](/docs/development_ua.md) | **Русский** | [Deutsch](/docs/development_de.md) | [Français](/docs/development_fr.md)
-
-## Разработка
-
-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 в подкаталогах
-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
-```

docs/development_ua.md

@@ -1,55 +0,0 @@
-[English](/docs/development.md) | **Українська** | [Русский](/docs/development_ru.md) | [Deutsch](/docs/development_de.md) | [Français](/docs/development_fr.md)
-
-## Розробка
-
-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
-
-# запустіть додаток електрон (термінал 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
-```