summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..510ad77
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# soc_dashboard
+
+## Development setup
+
+Run `soc_collector` checked out to tag `dashboard` on port 8001.
+
+Populate `soc_collector` with data from `example_data.json`:
+
+```
+cat example_data.json | curl -s -u user3:pw3 --data-binary @- http://localhost:8000/sc/v0/add
+```
+
+Get dependencies and start the front end:
+
+```
+npm run start
+```