From 7099edc5911c11ee1be20d05b6fc552a1ab99345 Mon Sep 17 00:00:00 2001 From: Valentin Zickner <3200232+vzickner@users.noreply.github.com> Date: Sun, 9 May 2021 20:11:10 +0200 Subject: [PATCH] simplify readme file since docker compose build is not required (#75) * simplify readme file since docker compose build is not required * add anchor navigation in README.md --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0d3426eba..46e0f3f57 100644 --- a/README.md +++ b/README.md @@ -68,19 +68,18 @@ The frontend is built with [Angular](https://angular.io). ### Setup 1. Run `yarn install` -2. Run `cd docker` -3. Run `docker compose build` -4. Run `docker compose up -d` to start [PostgreSQL](https://www.postgresql.org) and [Redis](https://redis.io) -5. Run `cd -` to go back to the project root directory -6. Run `yarn setup:database` to initialize the database schema and populate your database with (example) data -7. Start server and client (see _Development_) -8. Login as _Admin_ with the following _Security Token_: `ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9` -9. Go to the _Admin Control Panel_ and press _Gather All Data_ to fetch historical data -10. Press _Sign out_ and check out the _Live Demo_ +1. Run `cd docker` +1. Run `docker compose up -d` to start [PostgreSQL](https://www.postgresql.org) and [Redis](https://redis.io) +1. Run `cd -` to go back to the project root directory +1. Run `yarn setup:database` to initialize the database schema and populate your database with (example) data +1. Start server and client (see [_Development_](#Development)) +1. Login as _Admin_ with the following _Security Token_: `ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9` +1. Go to the _Admin Control Panel_ and press _Gather All Data_ to fetch historical data +1. Press _Sign out_ and check out the _Live Demo_ ## Development -Please make sure you have completed the instructions from _Setup_ +Please make sure you have completed the instructions from [_Setup_](#Setup) ### Start server