{"id":15032058,"url":"https://github.com/suchapalaver/gust","last_synced_at":"2025-04-09T21:22:41.691Z","repository":{"id":37000271,"uuid":"421622065","full_name":"suchapalaver/gust","owner":"suchapalaver","description":"Simplifies the process of preserving your recipes and creating comprehensive grocery shopping lists","archived":false,"fork":false,"pushed_at":"2024-01-05T00:39:28.000Z","size":601,"stargazers_count":6,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-23T23:15:19.771Z","etag":null,"topics":["beginner-friendly","beginner-project","clap","command-line-app","custom-error","deserialization","docker","error-handling","rust","rust-lang","rust-language","serde","serde-json","sqlite","traits"],"latest_commit_sha":null,"homepage":"https://github.com/suchapalaver/gust","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/suchapalaver.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-10-27T00:12:20.000Z","updated_at":"2024-07-31T22:59:00.000Z","dependencies_parsed_at":"2023-10-17T01:33:57.827Z","dependency_job_id":"4fc3a2b7-df29-4d64-8b6c-c15282236cd5","html_url":"https://github.com/suchapalaver/gust","commit_stats":{"total_commits":296,"total_committers":5,"mean_commits":59.2,"dds":0.5777027027027026,"last_synced_commit":"b411e7a8148a64c39eb3ab5d5a9f17a889fcbc29"},"previous_names":["suchapalaver/gust"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suchapalaver%2Fgust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suchapalaver%2Fgust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suchapalaver%2Fgust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suchapalaver%2Fgust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/suchapalaver","download_url":"https://codeload.github.com/suchapalaver/gust/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248112876,"owners_count":21049742,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beginner-friendly","beginner-project","clap","command-line-app","custom-error","deserialization","docker","error-handling","rust","rust-lang","rust-language","serde","serde-json","sqlite","traits"],"created_at":"2024-09-24T20:17:12.862Z","updated_at":"2025-04-09T21:22:41.652Z","avatar_url":"https://github.com/suchapalaver.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `gust`: rust-powered grocery list creator\n\nuse `gust` to add recipes and grocery items to a local database,\nmaking putting together shopping lists super quick.\n\n## summary\n\n- [documentation](#docs)\n- [getting started](#getting-started)\n\n## prerequisites\n\nThe main prerequisite to get started using this application is [Docker](https://docs.docker.com/).\nDocker allows you to [build](./docs/docker.md#build) an image of an application and [run](./docs/docker.md#run) application\n[containers](https://en.wikipedia.org/wiki/Containerization_(computing)), allowing you to use an application such as `gust` without\nneeding to install the Rust programming language, database software, or\nother dependencies on your computer.\n\nAll you need is to [install Docker](https://docs.docker.com/install/). \n\n---\n## docs\n\n### overview\n\n![`gust` design diagram](./docs/diagrams/design.svg)\n\n### [cli](./docs/cli.md)\n\n- [help](./docs/cli.md#help)\n- [fetching recipes](./docs/cli.md#fetching-recipes)\n- [importing/exporting data](./docs/cli.md#importing-and-exporting-data)\n\n### [database](./docs/database.md)\n\n- [storage options](./docs/database.md#storage-options)\n  - [sqlite](./docs/database.md#sqlite)\n  - [postgres](./docs/database.md#postgresql)\n\n### [docker](./docs/docker.md)\n\n- [data volumes](./docs/docker.md#creating-a-gust_data-volume)\n- [migrating from JSON to SQLite](./docs/docker.md#migrate-a-json-gust-store-to-sqlite)\n- [exporting data to YAML](./docs/docker.md#export-data-to-yaml)\n\n---\n## getting started\n\n### build the docker image\n\n```bash\ndocker build --tag gust --file Dockerfile .\n```\n\n### help menu\n\n```bash\ndocker run --rm gust\n```\n\nor:\n\n```bash\ncargo run -- -h    \n```\n\n### fetch a recipe and save it to the database\n\n```bash\ndocker run --rm -v gust:/app gust fetch --url https://www.bbc.co.uk/food/recipes/vegetable_noodle_pancake_22079\n```\n\n### read the recipes in the database\n\n```bash\ndocker run --rm -v gust:/app gust read recipes\n```\n\n### read a recipe's ingredients\n\n```bash\ndocker run --rm -v gust:/app gust read --recipe 'vegetable noodle pancake'\n```\n\n### add a recipe to the list\n\n```bash\ndocker run --rm -v gust:/app gust add list --recipe 'vegetable noodle pancake'\n```\n\n### read the items on the list\n\n```bash\ndocker run --rm -v gust:/app gust read list\n```\n\n### clear the list\n\n```bash\ndocker run --rm -v gust:/app gust update list clear\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuchapalaver%2Fgust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuchapalaver%2Fgust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuchapalaver%2Fgust/lists"}