cybercyst/bruno
1
0
Fork 0
mirror of https://github.com/usebruno/bruno.git synced 2025-05-05 15:32:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update contributing.md with contribution guidelines and setup instructions (#4377)

Browse Source 
---------
Co-authored-by: Anoop M D <anoop.md1421@gmail.com>
This commit is contained in:
ganesh 2025-04-03 14:50:57 +05:30 committed by GitHub
parent 841facc853
commit 2d1f7d0f33
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
contributing.md
View File

@ -37,15 +37,15 @@ Libraries we use
- Filesystem Watcher - chokidar - Filesystem Watcher - chokidar
- i18n - i18next - i18n - i18next
### Dependencies > [!IMPORTANT]
> You would need [Node v22.x or the latest LTS version](https://nodejs.org/en/). We use npm workspaces in the project
You would need [Node v20.x or the latest LTS version](https://nodejs.org/en/) and npm 8.x. We use npm workspaces in the project
## Development ## 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. 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.
### Local Development
## Install Dependencies
```bash ```bash
# use nodejs 20 version # use nodejs 20 version
@ -53,7 +53,11 @@ nvm use
# install deps # install deps
npm i --legacy-peer-deps npm i --legacy-peer-deps
```
### Local Development (Option 1)
```bash
# build packages # build packages
npm run build:graphql-docs npm run build:graphql-docs
npm run build:bruno-query npm run build:bruno-query
@ -62,13 +66,23 @@ npm run build:bruno-common
# bundle js sandbox libraries # bundle js sandbox libraries
npm run sandbox:bundle-libraries --workspace=packages/bruno-js npm run sandbox:bundle-libraries --workspace=packages/bruno-js
# run next app (terminal 1) # run react app (terminal 1)
npm run dev:web npm run dev:web
# run electron app (terminal 2) # run electron app (terminal 2)
npm run dev:electron npm run dev:electron
``` ```
### Local Development (Option 2)
```bash
# install dependencies and setup
npm run setup
# run electron and react app concurrently
npm run dev
```
### Troubleshooting ### 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. 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.