add npm watch info

CoEDL · Jul 21, 2020 · 60b90a0 · 60b90a0
1 parent 711b673
commit 60b90a0
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/docs/wiki/elpis-dev-recipe.md b/docs/wiki/elpis-dev-recipe.md
@@ -18,6 +18,9 @@ git clone --depth=1 -b elpis https://github.com/persephone-tools/espnet
 
 
 ## Build the GUI
+
+The Docker container has a build of the React app GUI in it, but if you are cloning the GUI repository and replacing the directory in the container with the local repository, the app build directory won't exist in the container (it is excluded from version control so it isn't in what you cloned). Run these commands to install the NPM libraries required, and to build a production version of the GUI into the `elpis-gui/build` dir. If you are developing the GUI, replace `npm run build` with `npm run watch` and then when you make changes to the GUI code, you'll get an automatic rebuild of the app. You will need to manually reload the browser that has the interface. 
+
 ```
 cd elpis-gui
 npm install && npm run build
@@ -40,7 +43,8 @@ docker run -it -p 5000:5000/tcp \
 
 ## Run the app
 
-Run this inside the container
+Run these inside the container to install stuff.
+
 ```
 source /venv/bin/activate
 python setup.py develop
@@ -50,7 +54,8 @@ export FLASK_APP=elpis && flask run --host=0.0.0.0 --port=5000
 
 ## Monitor the app/code
 
-Open a new Terminal and get another window into the running Elpis container using this (this works on Mac, untested on PC): 
+Open a new Terminal and get another window into the running Elpis container using this (this works on Mac, untested on PC)
+
 ```
 docker exec -it $(docker ps -q) bash
 ```