open-source-mirrors
/
ghostfolio
mirror of https://github.com/ghostfolio/ghostfolio
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c519eb0e99'
${ noResults }
ghostfolio/README.md

3.6 KiB
Raw Blame History

Ghostfolio

Open Source Portfolio Tracker

Live Demo

Build Status License: AGPL v3

Ghostfolio is an open source portfolio tracker based on web technology. The software 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
  • ✅ Multi account management
  • ✅ Portfolio performance (Today, YTD, 1Y, 5Y, Max)
  • ✅ Various charts
  • ✅ Static analysis to identify potential risks in your portfolio
  • ✅ Dark Mode
  • ✅ Zen Mode
  • ✅ Mobile-first design

Technology Stack

Ghostfolio is a modern web application written in TypeScript and organized as an Nx workspace.

Backend

The backend is based on NestJS using PostgreSQL as a database together with Prisma and Redis for caching.

Frontend

The frontend is built with Angular and uses Angular Material with utility classes from Bootstrap.

Getting Started

Prerequisites

Setup

  1. Run yarn install
  2. Run cd docker
  3. Run docker compose up -d to start PostgreSQL and Redis
  4. Run cd - to go back to the project root directory
  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
  8. Go to the Admin Control Panel and press Gather All Data to fetch historical data
  9. Press Sign out and check out the Live Demo

Development

Please make sure you have completed the instructions from Setup

Start server

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

Start client

Run yarn start:client

Testing

Run yarn test

License

© 2021 Ghostfolio

Licensed under the AGPLv3 License.