jamsch0/groceries
1
0
Fork 0
Code Issues Pull Requests Actions Packages Activity

Add readme

Browse Source
This commit is contained in:
James Chapman 2023-07-24 17:44:51 +01:00 committed by GitHub
parent be895620b6
commit 4fc1052829
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# Groceries
An application for (manually) tracking your grocery shopping habits.
## Installation
A pre-built image is available at [ghcr.io/jamsch0/groceries](https://ghcr.io/jamsch0/groceries).
The default configuration can be found in `config.ini` once the volume has been created.
Example usage:
```bash
$ docker run -d -p 8080:80 -v ./groceries:/config ghcr.io/jamsch0/groceries
```
## Configuration
Groceries uses a PostgreSQL database. The PostgreSQL connection is configured by setting the `Database` key in the config file:
```ini
# config.ini
Database = "Host=127.0.0.1;Username=groceries;Password=password;Database=groceries"
```
The application will attempt to create the database if it doesn't already exist.