mirror of
https://github.com/usebruno/bruno.git
synced 2024-11-25 01:14:23 +01:00
Merge branch 'main' of github.com:usebruno/bruno
This commit is contained in:
commit
01e15b7fc1
@ -1,28 +1,31 @@
|
|||||||
## Lets make bruno better, together !!
|
## 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.
|
|
||||||
|
I am happy that you are looking to improve bruno. Below are the guidelines to get started bringing up bruno on your computer.
|
||||||
|
|
||||||
### Technology Stack
|
### Technology Stack
|
||||||
|
|
||||||
Bruno is built using NextJs and React. We also use electron to ship a desktop version (that supports local collections)
|
Bruno is built using NextJs and React. We also use electron to ship a desktop version (that supports local collections)
|
||||||
|
|
||||||
Libraries we use
|
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
|
|
||||||
|
|
||||||
|
- CSS - Tailwind
|
||||||
|
- Code Editors - Codemirror
|
||||||
|
- State Management - Redux
|
||||||
|
- Icons - Tabler Icons
|
||||||
|
- Forms - formik
|
||||||
|
- Schema Validation - Yup
|
||||||
|
- Request Client - axios
|
||||||
|
- Filesystem Watcher - chokidar
|
||||||
|
|
||||||
### Dependencies
|
### Dependencies
|
||||||
You would need Node v14.x and npm 8.x. We use npm workspaces in the project
|
|
||||||
|
You would need [Node v14.x or the latest LTS version](https://nodejs.org/en/) and npm 8.x. We use npm workspaces in the project
|
||||||
|
|
||||||
### Lets start coding
|
### Lets start coding
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# clone and cd into bruno
|
# clone and cd into bruno
|
||||||
# use Node 14.x, Npm 8.x
|
# use Node 14.x, Npm 8.x
|
||||||
|
|
||||||
# Install deps (note that we use npm workspaces)
|
# Install deps (note that we use npm workspaces)
|
||||||
npm i
|
npm i
|
||||||
@ -41,4 +44,10 @@ open http://localhost:3000
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Raising Pull Request
|
### Raising Pull Request
|
||||||
* Please keep the PR's small and focused on one thing
|
|
||||||
|
- 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 container only bug fixes for a specific bug
|
||||||
|
- Example bugfix/bug-1
|
||||||
|
@ -29,6 +29,14 @@ I am happy that you are looking to improve bruno. Please checkout the [contribut
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
### Contributors
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<a href="https://github.com/usebruno/bruno/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=usebruno/bruno" />
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
### Support ❤️
|
### Support ❤️
|
||||||
Woof! If you like project, hit that ⭐ button !!
|
Woof! If you like project, hit that ⭐ button !!
|
||||||
@ -37,5 +45,6 @@ Woof! If you like project, hit that ⭐ button !!
|
|||||||
[Twitter](https://twitter.com/use_bruno) <br />
|
[Twitter](https://twitter.com/use_bruno) <br />
|
||||||
[Website](https://www.usebruno.com)
|
[Website](https://www.usebruno.com)
|
||||||
|
|
||||||
|
|
||||||
### License 📄
|
### License 📄
|
||||||
[MIT](license.md)
|
[MIT](license.md)
|
||||||
|
Loading…
Reference in New Issue
Block a user