2023-10-05 21:47:14 +02:00
|
|
|
**English** | [Русский](/contributing_ru.md)
|
|
|
|
|
|
2022-10-21 15:11:28 +02:00
|
|
|
## Lets make bruno better, together !!
|
2022-10-23 10:20:42 +02:00
|
|
|
|
|
|
|
|
I am happy that you are looking to improve bruno. Below are the guidelines to get started bringing up bruno on your computer.
|
2022-10-21 15:11:28 +02:00
|
|
|
|
|
|
|
|
### Technology Stack
|
2022-10-23 10:20:42 +02:00
|
|
|
|
2022-10-21 15:11:28 +02:00
|
|
|
Bruno is built using NextJs and React. We also use electron to ship a desktop version (that supports local collections)
|
|
|
|
|
|
2022-10-23 10:20:42 +02:00
|
|
|
Libraries we use
|
2022-10-21 15:11:28 +02:00
|
|
|
|
2022-10-23 10:20:42 +02:00
|
|
|
- CSS - Tailwind
|
|
|
|
|
- Code Editors - Codemirror
|
|
|
|
|
- State Management - Redux
|
|
|
|
|
- Icons - Tabler Icons
|
|
|
|
|
- Forms - formik
|
|
|
|
|
- Schema Validation - Yup
|
|
|
|
|
- Request Client - axios
|
|
|
|
|
- Filesystem Watcher - chokidar
|
2022-10-21 15:11:28 +02:00
|
|
|
|
|
|
|
|
### Dependencies
|
2022-10-23 10:20:42 +02:00
|
|
|
|
2023-10-03 10:39:38 +02:00
|
|
|
You would need [Node v18.x or the latest LTS version](https://nodejs.org/en/) and npm 8.x. We use npm workspaces in the project
|
2022-10-21 15:11:28 +02:00
|
|
|
|
|
|
|
|
### Lets start coding
|
|
|
|
|
|
2023-02-16 20:22:35 +01:00
|
|
|
Please reference [development.md](docs/development.md) for instructions on running the local development environment.
|
2022-10-21 15:11:28 +02:00
|
|
|
|
|
|
|
|
### Raising Pull Request
|
2022-10-23 10:20:42 +02:00
|
|
|
|
|
|
|
|
- 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
|
