Merge branch 'main' into bugfix/filename-validation

.github/PULL_REQUEST_TEMPLATE.md

@@ -11,3 +11,7 @@
 - [ ] **Create an issue and link to the pull request.**
 
 Note: Keeping the PR small and focused helps make it easier to review and merge. If you have multiple changes you want to make, please consider submitting them as separate pull requests.
+
+### Publishing to New Package Managers
+
+Please see [here](../publishing.md) for more information.

.github/workflows/release-snap.yml

@@ -27,7 +27,11 @@ jobs:
         run: npm install --legacy-peer-deps
 
       - name: Build Electron app
-        run: npm run build:electron:snap
+        run: |
+          npm run build:bruno-query
+          npm run build:graphql-docs
+          npm run build:web
+          npm run build:electron:snap
 
       - name: Install Snapcraft
         run: |

contributing.md

@@ -1,12 +1,12 @@
-**English** | [Українська](/contributing_ua.md) | [Русский](/contributing_ru.md)
+**English** | [Українська](docs/contributing/contributing_ua.md) | [Русский](docs/contributing/contributing_ru.md) | [Türkçe](docs/contributing/contributing_tr.md) | [Deutsch](docs/contributing/contributing_de.md) | [Français](docs/contributing/contributing_fr.md)
 
-## Lets make bruno better, together !!
+## Let's 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.
+We are happy that you are looking to improve bruno. Below are the guidelines to get started bringing up bruno on your computer.
 
 ### Technology Stack
 
-Bruno is built using NextJs and React. We also use electron to ship a desktop version (that supports local collections)
+Bruno is built using Next.js and React. We also use electron to ship a desktop version (that supports local collections)
 
 Libraries we use
 
@@ -23,15 +23,65 @@ Libraries we use
 
 You would need [Node v18.x or the latest LTS version](https://nodejs.org/en/) and npm 8.x. We use npm workspaces in the project
 
-### Lets start coding
+## Development
 
-Please reference [development.md](docs/development.md) for instructions on running the local development environment.
+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
+```
 
 ### Raising Pull Request
 
 - Please keep the PR's small and focused on one thing
 - Please follow the format of creating branches
   - feature/[feature name]: This branch should contain changes for a specific feature
     - Example: feature/dark-mode
-  - bugfix/[bug name]: This branch should container only bug fixes for a specific bug
+  - bugfix/[bug name]: This branch should contain only bug fixes for a specific bug
     - Example bugfix/bug-1

docs/contributing/contributing_de.md

@@ -0,0 +1,89 @@
+## Lass uns Bruno noch besser machen, gemeinsam !!
+
+Ich freue mich, dass Du Bruno verbessern möchtest. Hier findest Du eine Anleitung, mit der Du Bruno auf Deinem Computer einrichten kannst.
+
+### Technologie Stack
+
+Bruno ist mit Next.js und React erstellt. Außerdem benötigen wir electron für die Desktop Version (die lokale Sammlungen unterstützt).
+
+Bibliotheken die wir benutzen
+
+- CSS - Tailwind
+- Code Editoren - Codemirror
+- State Management - Redux
+- Icons - Tabler Icons
+- Formulare - formik
+- Schema Validierung - Yup
+- Request Client - axios
+- Dateisystem Watcher - chokidar
+
+### Abhängigkeiten
+
+Du benötigst [Node v18.x oder die neuste LTS Version](https://nodejs.org/en/) und npm 8.x. Wir benutzen npm workspaces in dem Projekt.
+
+### Lass uns coden
+
+Eine Anleitung zum Ausführen einer lokalen Entwicklungsumgebung findest Du in [development.md](docs/development_de.md).
+
+### Pull Request erstellen
+
+- Bitte halte die PRs klein und begrenzt auf eine Sache
+- Bitte halte Dich beim Erstellen eines Branches an das folgende Format
+  - feature/[feature name]: Dieser Branch soll Änderungen für ein bestimmtes Feature enthalten
+    - 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

@@ -0,0 +1,89 @@
+## Ensemble, améliorons Bruno !
+
+Je suis content de voir que vous envisagez améliorer Bruno. Ci-dessous, vous trouverez les règles et guides pour récupérer Bruno sur votre ordinateur.
+
+### Technologies utilisées
+
+Bruno est construit en utilisant NextJs et React. Nous utilisons aussi Electron pour embarquer la version ordinateur (qui permet les collections locales).
+
+Les bibliothèques que nous utilisons :
+
+- CSS - Tailwind
+- Code Editors - Codemirror
+- State Management - Redux
+- Icons - Tabler Icons
+- Forms - formik
+- Schema Validation - Yup
+- Request Client - axios
+- Filesystem Watcher - chokidar
+
+### Dépendances
+
+Vous aurez besoin de [Node v18.x ou la dernière version LTS](https://nodejs.org/en/) et npm 8.x. Nous utilisons aussi les espaces de travail npm (_npm workspaces_) dans ce projet.
+
+### Commençons à coder
+
+Veuillez vous référez à la [documentation de développement](docs/development_fr.md) pour les instructions de démarrage de l'environnement de développement local.
+
+### Ouvrir une Pull Request
+
+- Merci de conserver les PR petites et focalisées sur un seul objectif
+- Merci de suivre le format de nom des branches
+  - feature/[feature name]: Cette branche devrait contenir une fonctionnalité spécifique
+    - 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
+```