From 975ab8a5e99bdbba754f6ff402cef6f14344bc81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A1szl=C3=B3=20Monda?= Date: Sat, 23 Dec 2017 19:24:13 +0100 Subject: [PATCH] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d54292cf..92be3689 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ The **web build** is meant to be used for demonstation purposes, so people who d The two builds share code as much as possible. -## Set up instructions +## Building the electron application First up, make sure that node >=8.1.x and npm >=5.1.x are installed on your system. Next up: @@ -34,6 +34,13 @@ npm run electron At this point, Agent should be running on your machine. +## Developing the web application + +- The frontend code is located in `packages/uhk-web/` +- Run the project locally with `npm run server:web` +- View the app at `http://localhost:8080` +- The app will automatically reload when you make changes + ## Contributing Wanna contribute? Please let us show you [how](CONTRIBUTING.md).