diff options
| author | Michael Muré <batolettre@gmail.com> | 2021-02-09 10:03:26 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-09 10:03:26 +0100 |
| commit | 3d86c1cc783adf448c38a51a3bcbbdf9621dc70d (patch) | |
| tree | 325e120b151d27f9c4486527cd8a5dfbbdbe8be3 /webui/Readme.md | |
| parent | 7829db8850643b6ad2b36f8747d01f66df9024d8 (diff) | |
| download | git-bug-3d86c1cc783adf448c38a51a3bcbbdf9621dc70d.tar.gz | |
Apply suggestions from code review
Diffstat (limited to 'webui/Readme.md')
| -rw-r--r-- | webui/Readme.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/webui/Readme.md b/webui/Readme.md index d1420b4f..50d7afa6 100644 --- a/webui/Readme.md +++ b/webui/Readme.md @@ -4,23 +4,23 @@ ### Run GraphQL backend -1. Download a git-bug stable binary. +1. Download a git-bug stable binary or compile your own by running `make` in the **root** directory: -2. Execute git-bug binary inside directory for the git repository it will manage issues: - - git-bug webui -p 3001 +2. Run the git-bug binary inside your git repository. It will manage issues and start the API: + - `git-bug webui -p 3001` ### Run ReactJS front-end -1. Clone git-bug repository. +1. If you haven't already, clone the git-bug repository: -2. Enter webui directory and install libraries needed: - - npm install +2. Enter the `webui` directory and install the needed libraries: + - `make install` or `npm install` -3. Generate ts code from graphql files and run webui in development mode - - npm start - - If You got compilation errors from lint, run lint command below and start again: - - npm run lint -- --fix - - npm start +3. Generate the TS code from the GrapQL files and run the webui in development mode: + - `make start` or `npm start` + - If you get some lint errors, run the lint command below and start again: + - `make fix-lint` or `npm run lint -- --fix` + - `make start` or `npm start` The development version of the WebUI is configured to query the backend on the port 3001. You can now live edit the js code and use the normal backend. |