Browse Source

optimize readme instruction for development setup

pull/6/head
Valentin Zickner 4 years ago
committed by Thomas
parent
commit
576318296c
  1. 21
      README.md

21
README.md

@ -61,7 +61,7 @@ The frontend is built with [Angular](https://angular.io).
### 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)
@ -69,24 +69,25 @@ The frontend is built with [Angular](https://angular.io).
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`

Loading…
Cancel
Save