MichaelMure/git-bug
1
1
Fork 0
mirror of https://github.com/MichaelMure/git-bug.git synced 2024-12-14 08:45:30 +03:00
Code Issues Projects Releases Wiki Activity

Commit for #557

Browse Source 
- Adding more details
- Tip when lint error occur
This commit is contained in:
Cláudio 2021-02-08 18:44:18 -03:00
parent 29ea8df425
commit 8d71888c6d
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
webui/Readme.md
View File

@ -2,15 +2,28 @@
## How to develop
1. Compile the go binary
- run `make` in the **root** directory
2. Run the GraphQL backend on the port 3001
- `./git-bug webui -p 3001`
3. Run the hot-reloadable development WebUI
### Run GraphQL backend
- run `npm start` in the **webui** directory
1. Download a git-bug stable binary.
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.
2. Execute git-bug binary inside directory for the git repository it will manage issues:
- git-bug webui -p 3001
### Run ReactJS front-end
1. Clone git-bug repository.
2. Enter webui directory and install libraries needed:
- npm install
3. Generate ts code from graphql files and run webui in development mode
- npm start
3.1. If You got compilation errors from lint, run lint command below and start again:
- npm run lint -- --fix
- npm start
3.2. 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.
## Bundle the web UI