feat: added contributing guide

This commit is contained in:
Anoop M D 2022-10-21 18:41:28 +05:30
parent 3c3c9a6026
commit bd6ce6a67b
3 changed files with 57 additions and 2 deletions

44
contributing.md Normal file
View File

@ -0,0 +1,44 @@
## Lets make bruno better, together !!
I am happy that you are looking to improve bruno. Below are the guidelines to get started bringing up bruno on your computed.
### Technology Stack
Bruno is built using NextJs 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
### Dependencies
You would need Node v14.x and npm 8.x. We use npm workspaces in the project
### Lets start coding
```bash
# clone and cd into bruno
# use Node 14.x, Npm 8.x
# Install deps (note that we use npm workspaces)
npm i
# run next app
npm run dev:web
# run electron app
# neededonly if you want to test changes related to electron app
# please note that both web and electron use the same code
# if it works in web, then it should also work in electron
npm run dev:electron
# open in browser
open http://localhost:3000
```
### Raising Pull Request
* Please keep the PR's small and focused on one thing

Binary file not shown.

After

Width:  |  Height:  |  Size: 209 KiB

View File

@ -5,6 +5,10 @@ Opensource API Client.
Woof! Lets play with some api's [here](https://play.usebruno.com). Woof! Lets play with some api's [here](https://play.usebruno.com).
Your api must allow CORS for it to work in the browser, else checkout the chrome extension ot the desktop app Your api must allow CORS for it to work in the browser, else checkout the chrome extension ot the desktop app
You can visit the [Website](https://www.usebruno.com) or watch a [4 min demo](https://www.youtube.com/watch?v=wwXJW7_qyLA)
![bruno](packages/bruno-app/public/images/landing.png)
### Comparision with Similar tools ⚖️ ### Comparision with Similar tools ⚖️
Bruno is at early stages of development, and does not yet have all the bells and whistles. Bruno is at early stages of development, and does not yet have all the bells and whistles.
Here is a rundown of key areas where bruno is different from similar tools out there. Here is a rundown of key areas where bruno is different from similar tools out there.
@ -20,11 +24,18 @@ Here is a rundown of key areas where bruno is different from similar tools out
| Run in Browser | ✔️ | ✔️ | ✖️ | ✔️ | | Run in Browser | ✔️ | ✔️ | ✖️ | ✔️ |
| Multi Tab Requests | ✔️ | ✔️ | ✖️ | ✖️ | | Multi Tab Requests | ✔️ | ✔️ | ✖️ | ✖️ |
### Contribute 👩‍💻🧑‍💻
I am happy that you are looking to improve bruno. Please checkout the [contributing guide](contributing.md)
Even if you are not able to make contributions via code, please don't hesitate to file bugs and feature requests that needs to be implemented to solve your use case.
### Support ❤️ ### Support ❤️
Woof! If you like project, hit that ⭐ button !! Woof! If you like project, hit that ⭐ button !!
### Stay in touch 🌐 ### Stay in touch 🌐
[Twitter](https://twitter.com/use_bruno) [Twitter](https://twitter.com/use_bruno) <br />
[Website](https://www.usebruno.com)
### License 📄 ### License 📄
[MIT](license) [MIT](license.md)