summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst23
1 files changed, 17 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index 66184df9..126bedc5 100644
--- a/README.rst
+++ b/README.rst
@@ -143,7 +143,10 @@ The above instructions will install a python package that contains a pre-
bundled version of the javascript UI.
If you want to modify the javascript UI, then you need to be able to update the
-javascript bundle whenever a javascript or CSS source file changes.
+javascript bundle whenever a javascript or CSS source file changes. To support
+this, we build a python package of the javascript UI and install it in
+"development mode" so that changes to the contents of the package are reflected
+in bitmaskd immediately.
Prerequisites::
@@ -152,22 +155,27 @@ Prerequisites::
Next, run ``dev-install``::
cd ui
- make dev-install # install JS code as a python package in "develop" mode.
+ make dev-install
Now you should be able to run the user interface with debugging tools::
bitmaskd
- chromium-browser http://localhost:7070
+ cd ui
+ npm run ui
+
+This command is the same as running:
+
+ chromium-browser "http://localhost:7070/#$(cat ~/.config/leap/authtoken)"
Firefox does not work as well, because the UI is only tested with webkit-based
browsers.
-Chromium is not the best for this, however, because it uses a newer webkit.
-Instead, try qupzilla::
+Chromium is not the most ideal, however, because it uses a newer webkit than is
+available in Qt. Instead, try qupzilla::
sudo apt install qupzilla
bitmaskd
- qupzilla -ow http://localhost:7070
+ qupzilla -ow "http://localhost:7070/#$(cat ~/.config/leap/authtoken)"
If you make a change to any of the CSS or JS source files, you need to rebuild
the javascript bundle. You can do this continually as files change like so::
@@ -175,6 +183,9 @@ the javascript bundle. You can do this continually as files change like so::
cd ui
node run watch
+The new javascript bundle will be used when you refresh the page so long as
+``make dev-install`` was previously run.
+
For more information, see ``ui/README.md``.
License