Skip to content

Recipe Buddy is a tool that enables the easy adding of recipes to Grocy through web scraping.

License

Notifications You must be signed in to change notification settings

redfive2012/recipe-buddy

 
 

Repository files navigation

Recipe Buddy

Backend CI wakatime

Update - May 2023

I am painfully aware of all the issues that beset Recipe Buddy relating to Mongo not working on certain architectures, recipes not scraping properly etc, and I am almost finished with a complete rewrite using a much more modern and (hopefully) reliable stack. You can check progress out on the t3-rewrite branch.

I am also actively seeking someone who likes writing frontend code more than me to collaborate on this - please do reach out in the Discussions tab if you'd like to help!

The problem

I am getting sick of manually importing recipes into Grocy.

The solution

Overcomplication, naturally. Recipe Buddy is a web app which scrapes web pages for the delicious structured metadata embedded therein.

Once the recipe has been extracted from the page, Recipe Buddy gives you a nice easy means to match each of its ingredients up with a product from your Grocy stock, as well as a quantity unit. Once this is done, you simply hit the 'Add Recipe' button, and the TypeScript goblins painstakingly transcribe the recipe into your Grocy instance, ready for meal planning!

How you can have a go

"Well gee, George, that sounds mighty swell", I hear you say, "but how does little old me go about harnessing the TypeScript goblins for my own recipe-scraping requirements?"

Well, dear reader, as I am a benevolent goblin-wrangler, I have imprisoned them in some poorly written Dockerfiles for you! All one needs to do to benefit from the gobliny goodness is as follows:

  1. Clone this repo into a directory of your choice: git clone https://github.com/georgegebbett/recipe-buddy.git
  2. Navigate into this new directory and utter the sacred incantation: docker-compose up
  3. Open your favourite browser like the intrepid web-o-naut you are, and visit port 4000 on the machine you ran the aforementioned command on
  4. ???
  5. Profit

A disclaimer

I am not (yet) a professional software engineer. I certainly do not profess to be any good at this stuff. I hereby abdicate any responsibility for the misbehaviour of the TypeScript goblins. If you think you can do better, then open a PR and I will almost certainly merge it without question.

Lots of love, George xoxoxoxo

About

Recipe Buddy is a tool that enables the easy adding of recipes to Grocy through web scraping.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.0%
  • Other 2.0%