holm/bruno
1
0
Fork 0
forked from extern/bruno
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #98 from dcoomber/bugfix/contributing

Browse Source 
Removed redundant instructions in docs
This commit is contained in:
Anoop M D 2023-02-17 14:06:05 +05:30 committed by GitHub
commit 0244b2e1d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
contributing.md
View File

@ -23,25 +23,7 @@ You would need [Node v14.x or the latest LTS version](https://nodejs.org/en/) an
### 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
```
Please reference [development.md](docs/development.md) for instructions on running the local development environment.
### Raising Pull Request

6
docs/development.md
View File

@ -18,10 +18,10 @@ npm i --legacy-peer-deps
npm run build:graphql-docs
# run next app (terminal 1)
npm run dev --workspace=packages/bruno-app
npm run dev:web
# run electron app (terminal 2)
npm run dev --workspace=packages/bruno-electron
npm run dev:electron
```
### Troubleshooting
@ -35,6 +35,6 @@ You might encounter a `Unsupported platform` error when you run `npm install`. T
npm test --workspace=packages/bruno-schema
# bruno-lang
npm test --workspace=packages/bruno-schema
npm test --workspace=packages/bruno-lang
```