aboutsummaryrefslogtreecommitdiffstats
path: root/webui/Readme.md
diff options
context:
space:
mode:
authorCláudio <claudio.engdist@gmail.com>2021-02-14 23:48:37 -0300
committerCláudio <claudio.engdist@gmail.com>2021-02-14 23:48:37 -0300
commit76d1ea1f4f5e75824ec4f65faeb70c906fd1d9f6 (patch)
tree1b813e1b03e2cfaa57929c0753cf43474b1fbc97 /webui/Readme.md
parent956f98b676ab44d19ed522061c9520a32aab1a3c (diff)
downloadgit-bug-76d1ea1f4f5e75824ec4f65faeb70c906fd1d9f6.tar.gz
Commits for issues #564 e #566
Diffstat (limited to 'webui/Readme.md')
-rw-r--r--webui/Readme.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/webui/Readme.md b/webui/Readme.md
index 50d7afa6..29b2f1cd 100644
--- a/webui/Readme.md
+++ b/webui/Readme.md
@@ -1,5 +1,17 @@
# git-bug rich web UI
+## Prerequisites
+
+<div align="center">
+<img height="119px" alt="ReactJS" src="./public/reactjs_logo.png">
+<img width="150px" src="./public/materialui_logo.svg">
+<img height="119px" src="./public/graphql_logo.svg">
+<img height="119px" src="./public/apollo_logo.svg">
+</div>
+<div align="center">
+ReactJS | Material UI | GraphQL | Apollo GraphQL
+</div>
+
## How to develop
### Run GraphQL backend
@@ -26,4 +38,7 @@ The development version of the WebUI is configured to query the backend on the p
## 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.
+Once the webUI is good enough for a new release:
+1. run `make build` from webui folder
+2. run `make pack-webui` from the *root directory* to bundle the compiled js into the go binary.
+ - You must have Go installed on Your machine to run this command. \ No newline at end of file