jon/README.md

38 lines
742 B
Markdown

# jon
> the tamer of garfield
## Setup
```
pip install -r requirements.txt
```
You should probably use a virtualenv for that.
I develop `jon` using Python 3.10 but it should work with older versions as well.
## Running
```
flask --app jon run --debug
```
`--debug` restarts the server when a source file changes.
## fsmi-db forward
```
ssh -nNTvL 5432:fsmi-db.fsmi.org:5432 fsmi-login.fsmi.org
```
## TODO
- [ ] Implement item and snack entry as Elm application
- [ ] Needs good documentation for maintainability
- [ ] Implement and document report generation
- [ ] How many days will the item last?
- [ ] How many do we need to last X months?
- [ ] etc.
- [ ] Make it print nicely
- [ ] Make it possible to edit entries