From 800508c6d909a0f8656847cf3b1f716168b088a4 Mon Sep 17 00:00:00 2001 From: Yash Date: Mon, 25 Nov 2024 14:25:53 +0530 Subject: [PATCH] feat: update contributing.md --- contributing.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index dbfb9b5eb..7b85a7c38 100644 --- a/contributing.md +++ b/contributing.md @@ -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. -### Local Development +### Local Development - npm ```bash # use nodejs 20 version @@ -69,6 +69,33 @@ npm run dev:web 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 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.