extern/bruno
1
0
Fork 1
mirror of https://github.com/usebruno/bruno.git synced 2024-12-22 23:02:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: update contributing.md

Browse Source
This commit is contained in:
Yash 2024-11-25 14:25:53 +05:30
parent d9ff55f504
commit 800508c6d9
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
contributing.md
View File

@ -45,7 +45,7 @@ You would need [Node v20.x or the latest LTS version](https://nodejs.org/en/) an
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 ### Local Development - npm
```bash ```bash
# use nodejs 20 version # use nodejs 20 version
@ -69,6 +69,33 @@ npm run dev:web
npm run dev:electron npm run dev:electron
``` ```
### Local Development - Makefile
```shell
# install deps
make install
# build packages
make build-graphql
make build-query
make build-common
# build all packages
make build-all
# bundle js sandbox libraries
make build-sandbox
# run next app (terminal 1)
make run-web
# run electron app (terminal 2)
make run-app
# run full suite locally
make 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.