From 3c9e91334959b088dee3cc56829992bd945b0cdb Mon Sep 17 00:00:00 2001 From: areebniyas Date: Thu, 26 Oct 2023 00:48:05 +0530 Subject: [PATCH] merge development and contributing doc --- contributing.md | 54 ++++++++++++++++++ .../contributing/contributing_de.md | 54 ++++++++++++++++++ .../contributing/contributing_fr.md | 54 ++++++++++++++++++ .../contributing/contributing_ru.md | 54 ++++++++++++++++++ .../contributing/contributing_tr.md | 0 .../contributing/contributing_ua.md | 54 ++++++++++++++++++ docs/development.md | 55 ------------------- docs/development_de.md | 55 ------------------- docs/development_fr.md | 55 ------------------- docs/development_ru.md | 55 ------------------- docs/development_ua.md | 55 ------------------- readme_de.md => docs/readme/readme_de.md | 0 readme_fr.md => docs/readme/readme_fr.md | 0 readme_ru.md => docs/readme/readme_ru.md | 0 readme_tr.md => docs/readme/readme_tr.md | 0 readme_ua.md => docs/readme/readme_ua.md | 0 16 files changed, 270 insertions(+), 275 deletions(-) rename contributing_de.md => docs/contributing/contributing_de.md (54%) rename contributing_fr.md => docs/contributing/contributing_fr.md (56%) rename contributing_ru.md => docs/contributing/contributing_ru.md (55%) rename contributing_tr.md => docs/contributing/contributing_tr.md (100%) rename contributing_ua.md => docs/contributing/contributing_ua.md (55%) delete mode 100644 docs/development.md delete mode 100644 docs/development_de.md delete mode 100644 docs/development_fr.md delete mode 100644 docs/development_ru.md delete mode 100644 docs/development_ua.md rename readme_de.md => docs/readme/readme_de.md (100%) rename readme_fr.md => docs/readme/readme_fr.md (100%) rename readme_ru.md => docs/readme/readme_ru.md (100%) rename readme_tr.md => docs/readme/readme_tr.md (100%) rename readme_ua.md => docs/readme/readme_ua.md (100%) diff --git a/contributing.md b/contributing.md index e2a558cce..55fedf0f7 100644 --- a/contributing.md +++ b/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 +``` diff --git a/contributing_de.md b/docs/contributing/contributing_de.md similarity index 54% rename from contributing_de.md rename to docs/contributing/contributing_de.md index 26b1ffb6a..fca88c609 100644 --- a/contributing_de.md +++ b/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 +``` diff --git a/contributing_fr.md b/docs/contributing/contributing_fr.md similarity index 56% rename from contributing_fr.md rename to docs/contributing/contributing_fr.md index d775083f1..f00a331c6 100644 --- a/contributing_fr.md +++ b/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 +``` diff --git a/contributing_ru.md b/docs/contributing/contributing_ru.md similarity index 55% rename from contributing_ru.md rename to docs/contributing/contributing_ru.md index 62fc5d03e..63e737f01 100644 --- a/contributing_ru.md +++ b/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 +``` diff --git a/contributing_tr.md b/docs/contributing/contributing_tr.md similarity index 100% rename from contributing_tr.md rename to docs/contributing/contributing_tr.md diff --git a/contributing_ua.md b/docs/contributing/contributing_ua.md similarity index 55% rename from contributing_ua.md rename to docs/contributing/contributing_ua.md index de7f3f4e9..8b563f3eb 100644 --- a/contributing_ua.md +++ b/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 +``` diff --git a/docs/development.md b/docs/development.md deleted file mode 100644 index af4d5d4a9..000000000 --- a/docs/development.md +++ /dev/null @@ -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 -``` diff --git a/docs/development_de.md b/docs/development_de.md deleted file mode 100644 index 0a30383aa..000000000 --- a/docs/development_de.md +++ /dev/null @@ -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 -``` diff --git a/docs/development_fr.md b/docs/development_fr.md deleted file mode 100644 index 4a5e69446..000000000 --- a/docs/development_fr.md +++ /dev/null @@ -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 -``` diff --git a/docs/development_ru.md b/docs/development_ru.md deleted file mode 100644 index be1aa8875..000000000 --- a/docs/development_ru.md +++ /dev/null @@ -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 -``` diff --git a/docs/development_ua.md b/docs/development_ua.md deleted file mode 100644 index c7de38f78..000000000 --- a/docs/development_ua.md +++ /dev/null @@ -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 -``` diff --git a/readme_de.md b/docs/readme/readme_de.md similarity index 100% rename from readme_de.md rename to docs/readme/readme_de.md diff --git a/readme_fr.md b/docs/readme/readme_fr.md similarity index 100% rename from readme_fr.md rename to docs/readme/readme_fr.md diff --git a/readme_ru.md b/docs/readme/readme_ru.md similarity index 100% rename from readme_ru.md rename to docs/readme/readme_ru.md diff --git a/readme_tr.md b/docs/readme/readme_tr.md similarity index 100% rename from readme_tr.md rename to docs/readme/readme_tr.md diff --git a/readme_ua.md b/docs/readme/readme_ua.md similarity index 100% rename from readme_ua.md rename to docs/readme/readme_ua.md