mirror of
https://codeberg.org/metamuffin/abrechenbarkeit.git
synced 2024-12-27 15:44:34 +00:00
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
# Abrechenbarkeit v2
|
|
|
|
A _simpler_ trust based ledger.
|
|
|
|
The entire application is contained within `abrechenbarkeit.lua`. This script
|
|
implements CGI. It was tested against Lua version 5.4.7. Application data is
|
|
stored in a number of files in the process working directory (See below).
|
|
|
|
The repository also contains a configuration file for the
|
|
[gnix http server](https://codeberg.org/metamuffin/gnix) (`gnix.yaml`) which is
|
|
useful for development or proxyless deployments.
|
|
|
|
## Data Files
|
|
|
|
- `log` stores the transaction log as CSV (`time,user_a,user_b,amount,pcode,pcount,comment`)
|
|
- `products` stores the product list as CSV (`barcode,price,user,name`)
|
|
- `config` stores configuration parameters as ESV (`key=value`)
|
|
- `transaction_sound`: URL to sound played when creating a transaction
|
|
|
|
## Migration from Strichliste
|
|
|
|
```
|
|
curl 'http://strichliste.example.org/api/user?deleted=false' | jq -r '.users.[] | [ 0, "@Potential", .name, .balance, "", "", "" ] | join(",")' > log
|
|
curl 'http://strichliste.example.org/api/article' | jq -r '.articles.[] | [ .barcode, .amount, "@Drinks", .name ] | join(",")' > products
|
|
```
|
|
|
|
## Non-linked User lists
|
|
|
|
- list of Users with negative balance: `http://abrechenbarkeit.example.org/?negative`
|
|
- list of Users with balance lower than <amount>: `http://abrechenbarkeit.example.org/?negative&maximum=<amount>`
|