finances/README.md

46 lines
2.9 KiB
Markdown

# pub.solar finances
This repository is used to track the finances of pub.solar transparently.
We use [hledger](https://hledger.org/) to create finance report in a minimalistic, terminal friendly
way.
### Finances report table
<style>
td { padding:0 0.5em; }
td:nth-child(1) { white-space:nowrap; }
tr:nth-child(even) td { background-color:#eee; }
</style><link rel="stylesheet" href="hledger.css"><table><tr><th colspan="3" style="text-align:left"><h2>Income Statement 2023</h2></th></tr><tr><th></th><th>Commodity</th><th>2023</th></tr><tr><td colspan="3">&nbsp;</td></tr><tr><th colspan="3" style="text-align:left">Revenues</th></tr><tr><td class="account" style="text-align:left">donations:member</td><td class="amount" style="text-align:right"></td><td class="amount" style="text-align:right">415.00</td></tr><tr><td class="account" style="text-align:left">donations:non-member</td><td class="amount" style="text-align:right"></td><td class="amount" style="text-align:right">87.00</td></tr><tr><th style="text-align:left">total</th><th class="amount coltotal" style="text-align:right"></th><th class="amount coltotal" style="text-align:right">502.00</th></tr><tr><td colspan="3">&nbsp;</td></tr><tr><th colspan="3" style="text-align:left">Expenses</th></tr><tr><td class="account" style="text-align:left">infra:domain</td><td class="amount" style="text-align:right"></td><td class="amount" style="text-align:right">52.40</td></tr><tr><td class="account" style="text-align:left">infra:file-storage</td><td class="amount" style="text-align:right"></td><td class="amount" style="text-align:right">26.02</td></tr><tr><td class="account" style="text-align:left">infra:server</td><td class="amount" style="text-align:right"></td><td class="amount" style="text-align:right">124.47</td></tr><tr><th style="text-align:left">total</th><th class="amount coltotal" style="text-align:right"></th><th class="amount coltotal" style="text-align:right">202.89</th></tr><tr><td colspan="3">&nbsp;</td></tr><tr><th style="text-align:left">Net:</th><th class="amount coltotal" style="text-align:right"></th><th class="amount coltotal" style="text-align:right">299.11</th></tr></table>
### Quick start how to use hledger
Installing hledger with [nix](https://nixos.org/download), the package manager.
```
git clone gitea@git.pub.solar:pub-solar/finances.git finances && cd $_
nix develop
```
or with [direnv](https://github.com/nix-community/nix-direnv).
```
git clone gitea@git.pub.solar:pub-solar/finances.git finances && cd $_
direnv allow
```
Creating a report without negative numbers
```
hledger incomestatement --file ./finances.hledger --layout bare --pretty --drop 1
```
Creating a web report, viewable in a browser
```
hledger-web --file ./finances.hledger
```
Writing a HTML table to the README
```
hledger incomestatement --file ./finances.hledger --layout bare --pretty --drop 1 --output-format html --yearly >> README.md
```