From a11fe12ac1b3d11f9f4843da947bdd1199d2fd90 Mon Sep 17 00:00:00 2001 From: Valentin Zickner Date: Sat, 17 Apr 2021 17:51:53 +0200 Subject: [PATCH] optimize readme instruction for development setup --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 46b8ebbff..ec47177ce 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Ghostfolio is for you if you are... ### Prerequisites -- [Node.js](https://nodejs.org/en/download) +- [Node.js](https://nodejs.org/en/download) (at least 14.x) - [Yarn](https://yarnpkg.com/en/docs/install) - [Docker](https://www.docker.com/products/docker-desktop) @@ -52,23 +52,24 @@ Ghostfolio is for you if you are... 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 `yarn setup:database` to initialize the database schema and populate your database with (example) data -6. Start server and client (see _Development_) -7. Login as _Admin_ with the following _Security Token_: `ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9` +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 main 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` -## Development +### Development -### Start server +#### Start server - Debug: Run `yarn watch:server` and click "Launch Program" in _Visual Studio Code_ - Serve: Run `yarn start:server` -### Start client +#### Start client - Run `yarn start:client` -## Testing +### Testing Run `yarn test`