Improve documentation (#5)
* Improve documentation * Extend feature section * Improve getting started instructions * Extend README.md * Minor change * Refactor list
This commit is contained in:
parent
6d070e2ea1
commit
2ee4d65c8d
36
README.md
36
README.md
@ -4,12 +4,40 @@
|
|||||||
<strong>Privacy-first Portfolio Tracker</strong>
|
<strong>Privacy-first Portfolio Tracker</strong>
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
<a href="https://www.ghostfol.io"><strong>Ghostfolio</strong></a>
|
<a href="https://www.ghostfol.io"><strong>Live Demo</strong></a>
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
**Ghostfolio** is a privacy-first portfolio tracker. It empowers busy folks to have a sharp look of their financial assets and to make solid, data-driven investment decisions by evaluating automated Static Portfolio Analysis Rules.
|
||||||
|
|
||||||
|
## Why Ghostfolio?
|
||||||
|
|
||||||
|
Ghostfolio is for you if you are...
|
||||||
|
|
||||||
|
- 💼 trading stocks, ETFs or cryptocurrencies on multiple platforms
|
||||||
|
|
||||||
|
- 🏦 pursuing a buy & hold strategy
|
||||||
|
|
||||||
|
- 🎯 interested in getting insights of your portfolio composition
|
||||||
|
|
||||||
|
- 👻 valuing privacy and data ownership
|
||||||
|
|
||||||
|
- 🧘 into minimalism
|
||||||
|
|
||||||
|
- 🧺 caring about diversifying your financial resources
|
||||||
|
|
||||||
|
- 🆓 interested in financial independence
|
||||||
|
|
||||||
|
- 🙅 saying no to spreadsheets in 2021
|
||||||
|
|
||||||
|
- 😎 still reading this list
|
||||||
|
|
||||||
## Features
|
## 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
|
- ✅ Dark Mode
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
@ -25,10 +53,10 @@
|
|||||||
1. Run `yarn install`
|
1. Run `yarn install`
|
||||||
2. Run `cd docker`
|
2. Run `cd docker`
|
||||||
3. Run `docker compose build`
|
3. Run `docker compose build`
|
||||||
4. Run `docker compose up -d`
|
4. Run `docker compose up -d` to start [PostgreSQL](https://www.postgresql.org) and [Redis](https://redis.io)
|
||||||
5. Run `yarn setup:database`
|
5. Run `yarn setup:database` to initialize the database schema and populate your database with (example) data
|
||||||
6. Start server and client (see _Development_)
|
6. Start server and client (see _Development_)
|
||||||
7. Login as _Admin_ with the `Security Token`: `ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9`
|
7. Login as _Admin_ with the following _Security Token_: `ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9`
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user