aboutsummaryrefslogtreecommitdiffstats
path: root/webui
diff options
context:
space:
mode:
Diffstat (limited to 'webui')
-rw-r--r--webui/Readme.md22
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.