Browse Source

Improve documentation

* Extend feature section
* Improve getting started instructions
pull/5/head
Thomas 4 years ago
parent
commit
bf5ec6a929
  1. 8
      README.md

8
README.md

@ -10,6 +10,10 @@
## Features
- ✅ Create, update and delete transactions
- ✅ Portfolio performance (`Today`, `YTD`, `1Y`, `5Y`, `Max`)
- ✅ Various charts
- ✅ Static analysis to identify potential risks in your portfolio
- ✅ Dark Mode
## Getting Started
@ -25,8 +29,8 @@
1. Run `yarn install`
2. Run `cd docker`
3. Run `docker compose build`
4. Run `docker compose up -d`
5. Run `yarn setup:database`
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 `Security Token`: `ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9`

Loading…
Cancel
Save