https://github.com/dtrai2/shiny-invoice
This tool is meant as a simple and naive way to manage invoices locally.
https://github.com/dtrai2/shiny-invoice
Last synced: 12 months ago
JSON representation
This tool is meant as a simple and naive way to manage invoices locally.
- Host: GitHub
- URL: https://github.com/dtrai2/shiny-invoice
- Owner: dtrai2
- License: mit
- Created: 2024-06-22T15:12:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T17:09:53.000Z (almost 2 years ago)
- Last Synced: 2025-01-29T10:49:15.468Z (over 1 year ago)
- Language: Python
- Size: 373 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shiny Invoice
This tool is meant as a simple and naive way to manage invoices locally.
It is not meant to be published online and used as an enterprise tool.
## Run
### With Python
To run `shiny-invoice` you need install it with:
```bash
pip install shiny-invoice
```
Once `shiny-invoice` is installed you need to create configuration file.
A suitable default configuration can be generated with
```bash
shiny-invoice generate-default-config
```
Once everything is set up you can run `shiny-invoice` with:
```bash
shiny-invoice run --config default_config.yaml
```
More information you can find with
```bash
shiny-invoice --help
shiny-invoice run --help
```
### With Container
Execute the following line in a directory that has the `config.yaml` file.
```bash
podman pull ghcr.io/dtrai2/shiny_invoice:latest
podman run -p 8000:8000 --volume .:/home/app -ti --rm shiny_invoice:latest run --config config.yaml
```
## Workflow
This application manages the invoices as plain html files, named by the invoice id.
To turn the html file into a pdf just use the browsers print functionality.
All the data corresponding to the invoices is stored inside a json file, which is configured with the key
`paths.datastore`.
The json you can edit as you like, via the gui it is only possible to change the 'Paid At' value.
This value is also used to determine if in invoice is indeed 'Paid' or 'Unpaid'.
## Impressions
### View of creating a new invoice
### View of existing invoices
