diff options
| author | Michael Muré <batolettre@gmail.com> | 2018-09-16 13:50:53 +0200 |
|---|---|---|
| committer | Michael Muré <batolettre@gmail.com> | 2018-09-16 13:50:53 +0200 |
| commit | 6f5d433e33b5432887a8496074f0d7c7048c1167 (patch) | |
| tree | dbde7ddd52cad8207c637012ceba839fd00c5fc9 /webui/Readme.md | |
| parent | b9fc8b662ed72844a93d1019b1ecf8b60464f78e (diff) | |
| download | git-bug-6f5d433e33b5432887a8496074f0d7c7048c1167.tar.gz | |
docs & cleaning
Diffstat (limited to 'webui/Readme.md')
| -rw-r--r-- | webui/Readme.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/webui/Readme.md b/webui/Readme.md new file mode 100644 index 00000000..e75fa6b8 --- /dev/null +++ b/webui/Readme.md @@ -0,0 +1,16 @@ +# git-bug rich web UI + +## 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 `npm start` in the **webui** directory + +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 + +Once the webUI is good enough for a new release, run `make pack-webui` from the root directory to bundle the compiled js into the go binary.
\ No newline at end of file |