Skip to content

Commit

Permalink
Update docs (#1102)
Browse files Browse the repository at this point in the history
  • Loading branch information
ggravlingen authored Jan 1, 2025
1 parent 24fc5ea commit cc6fa8a
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Available features:
- A transaction chart: show historical price data along with markers for purchases and divestments.
- Profit- and loss statement: show the historical result from your transactions.

## What is this exactly?
## What exactly is this?

It's a web app running on your computer.

## Why
## But why

I've been looking for a library where I can download a set of transactions from my broker and pension fund manager use the merged data for analysis. When I couldn't find one, I decided to build it instead.

## No-cloud storage
## Could storage? No.

Your data is stored locally. The only thing cloud is that the library allows you to fetch market data from the Internet.

Expand All @@ -41,7 +41,7 @@ Click the images to view a larger version.

## Installing

Choose one of the two options below. I'm personally using (1).
Choose one of the options below. I'm personally using (1).

### (1) Running in VS Code

Expand All @@ -54,12 +54,18 @@ Choose one of the two options below. I'm personally using (1).
- Start the server in VSCode by clicking `Run and Debug` and then `Pypmanager server`.
- Browse to the transaction list on `http://localhost:8001/#/transaction`.

### (2) Running as a stand-alone Docker service
### (2) Building a Docker image from the source and Running as a stand-alone Docker service

- Build the Docker image file: `docker build . --tag pypmanager:latest`.
- Spin up a container and mount your data folders: `docker run -p 8001:8001 -v ./data:/code/app/data pypmanager:latest`.
- Browse to the transaction list on `http://localhost:8001/#/transaction`.

### (3) Running a pre-build docker

- Fetch the docker image `docker pull ghcr.io/ggravlingen/pypmanager:2024.12.4`, where `2024.12.4` is the version you want to install.
- Spin up a container and mount your data folders: `docker run -p 8001:8001 -v ./data:/code/app/data pypmanager:2024.12.4`.
- Browse to the transaction list on `http://localhost:8001/#/transaction`.

## How do add transactions

Your own data goes into the folder `data/transactions`. If you make contributions to this library, _no_ files from the `data` folder should be committed to the library as it contains your own, private, data.
Expand Down
Binary file modified docs/assets/income_statement.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/portfolio_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/transaction_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cc6fa8a

Please sign in to comment.