summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErnst Widerberg <ernstwi@kth.se>2021-10-22 08:45:00 +0200
committerErnst Widerberg <ernstwi@kth.se>2021-10-22 08:45:00 +0200
commita8bdc43b4db58e404471ba858361b4e950a4f899 (patch)
treea4f9526be57384cf45aea38c8f93655e65e64628
parent9a1f512736480b7b1e8dcb37db3b4cdc0e4f5d11 (diff)
Update readme
-rw-r--r--README.md23
1 files changed, 12 insertions, 11 deletions
diff --git a/README.md b/README.md
index ed1a91e..8ec1b10 100644
--- a/README.md
+++ b/README.md
@@ -2,21 +2,22 @@
## Development setup
-Env vars:
-- `COLLECTOR_URL`
-- `JWT_URL`
-- `PER_PAGE`
+Quick start:
+- `source init.sh`
-The commit pointed to by the `soc_collector` submodule is compatible with `main` in this repo.
+What it does:
+- Starts `soc_collector` listening on `COLLECTOR_URL`
+- Starts `jwt_mock.go` listening on `JWT_URL`
+- Starts `soc_dashboard` listening on `http://localhost:8001`
-Populate `soc_collector` with data from `example_data.json`:
+---
-```
-cat example_data.json | curl -s -u user3:pw3 --data-binary @- ${COLLECTOR_URL}/sc/v0/add
-```
+The commit pointed to by the `soc_collector` submodule is compatible with `main` in this repo.
+
+---
-Get dependencies and start the front end:
+To populate `soc_collector` with data from `example_data.json`:
```
-npm run start
+cat example_data.json | curl -s -u user3:pw3 --data-binary @- ${COLLECTOR_URL}/sc/v0/add
```