ghostfolio/README.md

Ghostfolio

Open Source Wealth Management Software made for Humans

Live Demo | Ghostfolio Premium | Blog | Slack | Twitter

Ghostfolio is an open source wealth management software built with web technology. The application empowers busy people to keep track of their wealth like stocks, ETFs or cryptocurrencies and make solid, data-driven investment decisions.

Ghostfolio Premium

Our official Ghostfolio Premium cloud offering is the easiest way to get started. Due to the time it saves, this will be the best option for most people. The revenue is used for covering the hosting costs.

If you prefer to run Ghostfolio on your own infrastructure, please find further instructions in the section Run with Docker.

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: Time-weighted rate of return (TWR) for 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.

Run with Docker

Prerequisites

• Docker

Setup Docker Image

Run the following commands to build and start the Docker image:

docker-compose -f docker/docker-compose-build-local.yml build
docker-compose -f docker/docker-compose-build-local.yml up

Setup Database

Run the following command to setup the database once Ghostfolio is running:

docker-compose -f docker/docker-compose-build-local.yml exec ghostfolio yarn setup:database

Fetch Historical Data

Open http://localhost:3333 in your browser and accomplish these steps:

1. Login as Admin with the following Security Token: ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9
2. Go to the Admin Control Panel and click Gather All Data to fetch historical data
3. Click Sign out and check out the Live Demo

Development

Prerequisites

• Docker
• Node.js (version 14+)
• Yarn

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 click Gather All Data to fetch historical data
9. Click Sign out and check out the Live Demo

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

Start Storybook

Run yarn start:storybook

Testing

Run yarn test

Contributing

Ghostfolio is 100% free and open source. We encourage and support an active and healthy community that accepts contributions from the public - including you.

Not sure what to work on? We have got some ideas. Please join the Ghostfolio Slack channel, tweet to @ghostfolio_ or send an e-mail to hi@ghostfol.io. We would love to hear from you.

License

© 2021 Ghostfolio

Licensed under the AGPLv3 License.