mirror of
https://github.com/usebruno/bruno.git
synced 2024-11-28 10:53:13 +01:00
2e71e605ea
* add path parameters on bruno-app * add path parameters on bruno-cli * fix bruno-schema testing * fix generate request code not replace path parameter value --------- Co-authored-by: game5413 <febryanph10@gmail.com> Co-authored-by: Anoop M D <anoop.md1421@gmail.com>
88 lines
3.2 KiB
Markdown
88 lines
3.2 KiB
Markdown
[English](/contributing.md) | [Українська](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** | [Português (BR)](docs/contributing/contributing_pt_br.md) | [বাংলা](docs/contributing/contributing_bn.md) | [Español](docs/contributing/contributing_es.md) | [Română](docs/contributing/contributing_ro.md) | [Polski](docs/contributing/contributing_pl.md) | [简体中文](docs/contributing/contributing_cn.md) | [正體中文](docs/contributing/contributing_zhtw.md)
|
|
|
|
## Ensemble, améliorons Bruno !
|
|
|
|
Je suis content de voir que vous envisagez d'améliorer Bruno. Vous trouverez ci-dessous les règles et guides pour récupérer Bruno sur votre ordinateur.
|
|
|
|
### Technologies utilisées
|
|
|
|
Bruno est basé sur NextJs et React. Nous utilisons aussi Electron pour embarquer la version ordinateur (ce qui permet les collections locales).
|
|
|
|
Les librairies 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.
|
|
|
|
## Développement
|
|
|
|
Bruno est développé comme une application _client lourd_. Vous devrez charger l'application en démarrant nextjs dans un premier terminal, puis démarre l'application Electron dans un second.
|
|
|
|
### Dépendances
|
|
|
|
- NodeJS v18
|
|
|
|
### Développement local
|
|
|
|
```bash
|
|
# utiliser node en version 18
|
|
nvm use
|
|
|
|
# installation des dépendances
|
|
npm i --legacy-peer-deps
|
|
|
|
# construction des docs graphql
|
|
npm run build:graphql-docs
|
|
|
|
# construction de bruno query
|
|
npm run build:bruno-query
|
|
|
|
# démarrage de next (terminal 1)
|
|
npm run dev:web
|
|
|
|
# démarrage du client lourd (terminal 2)
|
|
npm run dev:electron
|
|
```
|
|
|
|
### Dépannage
|
|
|
|
Vous pourriez rencontrer une erreur `Unsupported platform` durant le lancement de `npm install`. Pour résoudre cela, veuillez supprimer le répertoire `node_modules` ainsi que le fichier `package-lock.json` et lancez à nouveau `npm install`. Cela devrait installer tous les paquets nécessaires pour lancer l'application.
|
|
|
|
```shell
|
|
# Efface les répertoires node_modules dans les sous-répertoires
|
|
find ./ -type d -name "node_modules" -print0 | while read -d $'\0' dir; do
|
|
rm -rf "$dir"
|
|
done
|
|
|
|
# Efface les fichiers package-lock.json dans les sous-répertoires
|
|
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
|
|
```
|
|
|
|
### Ouvrir une Pull Request
|
|
|
|
- Merci de conserver les PR minimes et focalisées sur un seul objectif
|
|
- Merci de suivre le format de nom des branches :
|
|
- feature/[feature name]: Cette branche doit contenir une fonctionnalité spécifique
|
|
- Exemple : feature/dark-mode
|
|
- bugfix/[bug name]: Cette branche doit contenir seulement une solution pour un bug spécifique
|
|
- Exemple : bugfix/bug-1
|