From c822ccc89c5ee63d474d260cda960688cc184df2 Mon Sep 17 00:00:00 2001 From: Joschka Rick Date: Wed, 15 Jan 2025 16:50:17 +0100 Subject: [PATCH] Create ios_with_mealie_openai --- .../community-guide/ios_with_mealie_openai | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/docs/documentation/community-guide/ios_with_mealie_openai diff --git a/docs/docs/documentation/community-guide/ios_with_mealie_openai b/docs/docs/documentation/community-guide/ios_with_mealie_openai new file mode 100644 index 000000000..16b9be79e --- /dev/null +++ b/docs/docs/documentation/community-guide/ios_with_mealie_openai @@ -0,0 +1,56 @@ +# Using iOS Shortcuts with Mealie + +!!! info + This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! + +Don't know what an iOS shortcut is? Neither did I! Experienced iOS users may already be familiar with this utility but for the uninitiated, here is the official Apple explanation: + +> A shortcut is a quick way to get one or more tasks done with your apps. The Shortcuts app lets you create your own shortcuts with multiple steps. For example, build a “Surf Time” shortcut that grabs the surf report, gives an ETA to the beach, and launches your surf music playlist. + +Basically it is a visual scripting language that lets a user build an automation in a guided fashion. The automation can be [shared with anyone](https://www.icloud.com/shortcuts/94aa272af5ff4d2c8fe5e13a946f89a9) but if it is a user creation, you'll have to jump through a few hoops to make an untrusted automation work on your device. + +## Guide + +### Prerequisites + +Before setting up the shortcut, make sure you have the following information ready and easily accessable on your Apple device. + +1. The URL of your Mealie instance +2. An API Token for your user + +### Setup + +On the Apple device you wish to add the shortcut to, click on [this link](https://www.icloud.com/shortcuts/f6a15e7751d247098bfdc2df3793367f) to begin the setup of the shortcut. + +![screenshot](../../assets/img/ios/setup.png) + +Next, you need to replace `url` and `port` with the information for your Mealie instance. + +If you have a domain that you use (e.g. `https://mealie.example.com`), put that here. If you just run local, then you need to put in your Mealie instance IP and the port you use (e.g. the default is `9000`). + +![screenshot](../../assets/img/ios/url.png) + +Next, you need to replace `MEALIE_API_KEY` with your API token. + +![screenshot](../../assets/img/ios/api.png) + +You may wish to [add the shortcut to your home screen](https://support.apple.com/guide/shortcuts/add-a-shortcut-to-the-home-screen-apd735880972/ios) for easier access. + +## Features + +- Share a website with Mealie to import via URL. +- Share a recipe photo from photos to import via image (parsed via OpenAI). +- Trigger the shortcut and take a photo of a physical recipe to import. +- Trigger the shortcut to select a photo from your Photos app to import. +- Trigger the shortcut to take a picture of a URL (like on the bottom of a printed recipe) to import. + + +## History + +User [brasilikum](https://github.com/brasilikum) opened an issue on the main repo about how they had created an [iOS shortcut](https://github.com/mealie-recipes/mealie/issues/103) for interested users. + +This original method broke after the transition to version 1.X and an issue was raised on [Github](https://github.com/mealie-recipes/mealie/issues/2092) GitHub user [Zippyy](https://github.com/zippyy) has helped to create a working shortcut for version 1.X. + +When OCR was removed from Mealie, GitHub user [hunterjm](https://github.com/zippyy) created a new shortcut that uses Apple's built-in OCR and Google Gemini to enhance and replace that functionality. + +When Mealie introduced image parsing via OpenAI, GitHub user [joschkarick](https://github.com/joschkarick) adjusted the shortcut to make use of the new recipe/create/image API.