bruno/contributing.md at 3b3ebcef9b19bac7d00e933201cdfbfb78ee552f

mirror of https://github.com/usebruno/bruno.git synced 2024-12-22 14:41:04 +01:00

Yash 800508c6d9 feat: update contributing.md

2024-11-25 14:25:53 +05:30

3.5 KiB

Raw Blame History

Let's make Bruno better, together!!

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 Next.js and React. We also use electron to ship a desktop version (that supports local collections)

Libraries we use

CSS - Tailwind
Code Editors - Codemirror
State Management - Redux
Icons - Tabler Icons
Forms - formik
Schema Validation - Yup
Request Client - axios
Filesystem Watcher - chokidar
i18n - i18next

Dependencies

You would need Node v20.x or the latest LTS version and npm 8.x. We use npm workspaces in the project

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.

Local Development - npm

# use nodejs 20 version
nvm use

# install deps
npm i --legacy-peer-deps

# build packages
npm run build:graphql-docs
npm run build:bruno-query
npm run build:bruno-common

# bundle js sandbox libraries
npm run sandbox:bundle-libraries --workspace=packages/bruno-js

# run next app (terminal 1)
npm run dev:web

# run electron app (terminal 2)
npm run dev:electron

Local Development - Makefile

# 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.

# 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

# bruno-schema
npm test --workspace=packages/bruno-schema

# bruno-lang
npm test --workspace=packages/bruno-lang

Raising Pull Requests

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 contain only bug fixes for a specific bug
  - Example bugfix/bug-1

3.5 KiB Raw Blame History