You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ghostfolio/README.md

2.0 KiB

Ghostfolio

Privacy-first Portfolio Tracker

Live Demo

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

  • 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

Prerequisites

Setup

  1. Run yarn install
  2. Run cd docker
  3. Run docker compose build
  4. Run docker compose up -d to start PostgreSQL and Redis
  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

Development

Start server

  • Debug: Run yarn watch:server and click "Launch Program" in Visual Studio Code
  • Serve: Run yarn start:server

Start client

  • Run yarn start:client

Testing

Run yarn test