README.md

gust: rust-powered grocery list creator

use gust to add recipes and grocery items to a local database, making putting together shopping lists super quick.

summary

• documentation
• getting started

prerequisites

The main prerequisite to get started using this application is Docker. Docker allows you to build an image of an application and run application containers, allowing you to use an application such as gust without needing to install the Rust programming language, database software, or other dependencies on your computer.

All you need is to install Docker.

---

docs

overview

cli

• help
• fetching recipes
• importing/exporting data

database

• storage options
  • sqlite
  • postgres

docker

• data volumes
• migrating from JSON to SQLite
• exporting data to YAML

---

getting started

build the docker image

docker build --tag gust --file Dockerfile .

help menu

docker run --rm gust

or:

cargo run -- -h    

fetch a recipe and save it to the database

docker run --rm -v gust:/app gust fetch --url https://www.bbc.co.uk/food/recipes/vegetable_noodle_pancake_22079

read the recipes in the database

docker run --rm -v gust:/app gust read recipes

read a recipe's ingredients

docker run --rm -v gust:/app gust read --recipe 'vegetable noodle pancake'

add a recipe to the list

docker run --rm -v gust:/app gust add list --recipe 'vegetable noodle pancake'

read the items on the list

docker run --rm -v gust:/app gust read list

clear the list

docker run --rm -v gust:/app gust update list clear