From a8bdc43b4db58e404471ba858361b4e950a4f899 Mon Sep 17 00:00:00 2001 From: Ernst Widerberg Date: Fri, 22 Oct 2021 08:45:00 +0200 Subject: Update readme --- README.md | 23 ++++++++++++----------- 1 file 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 ``` -- cgit v1.1