Thomas
87cd3ef33f
|
4 years ago | |
---|---|---|
.vscode | ||
apps | 4 years ago | |
docker | ||
libs/helper | 4 years ago | |
prisma | 4 years ago | |
tools | ||
.editorconfig | ||
.env | ||
.eslintrc.json | ||
.gitignore | ||
.prettierignore | ||
.prettierrc | ||
.yarnrc | ||
CHANGELOG.md | 4 years ago | |
LICENSE | ||
README.md | 4 years ago | |
angular.json | ||
decorate-angular-cli.js | ||
jest.config.js | ||
jest.preset.js | ||
nx.json | ||
package.json | 4 years ago | |
replace.build.js | ||
tsconfig.base.json | 4 years ago | |
yarn.lock |
README.md
Ghostfolio is an open source portfolio tracker. 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
- ✅ Portfolio performance (
Today
,YTD
,1Y
,5Y
,Max
) - ✅ Various charts
- ✅ Static analysis to identify potential risks in your portfolio
- ✅ Dark Mode
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 and Redis for caching.
Frontend
The frontend is built with Angular.
Getting Started
Prerequisites
Setup
- Run
yarn install
- Run
cd docker
- Run
docker compose build
- Run
docker compose up -d
to start PostgreSQL and Redis - Run
cd -
to go back to the project root directory - Run
yarn setup:database
to initialize the database schema and populate your database with (example) data - Start server and client (see Development)
- Login as Admin with the following Security Token:
ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9
- Go to the Admin Control Panel and press Gather All Data to fetch historical data
- Press Sign out and check out the Live Demo
Development
Please make sure you have completed the instructions from Setup
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
License
© 2021 Ghostfolio
Licensed under the AGPLv3 License.