MMM-MealieShoppingList

MMM-MealieShoppingList is a module for MagicMirror² that displays your Mealie meal plan for the week.

Description

This module shows your shopping list from Mealie.

Mealie is an intuitive and easy to use recipe management app. It's designed to make your life easier by being the best recipes management experience on the web and providing you with an easy to use interface to manage your growing collection of recipes.

Mealie is self-hostable, meaning you can run it on your own server without any reliance on cloud-services.

How it Works

After you installed MMM-MealieShoppingList you just configure it to your needs and that's it. You will need to provide the Mealie host and credentials as an apiKey.

For more information see the Configuration section.

Installation

Just clone MMM-MealieShoppingList into the modules folder of your MagicMirror² installation:

cd ~/MagicMirror/modules
git clone https://github.com/btoconnor/MMM-MealieShoppingList

Update

Go to the MMM-MealieShoppingList folder inside MagicMirror² modules folder and pull the latest version from GitHub:

cd ~/MagicMirror/modules/MMM-MealieShoppingList
git pull

Restart MagicMirror² after updating.

Configuration

In order to use this module, you simply need to provide the host apiKey, and the shoppingListID of the shopping list you'd like to display..

These are the possible options:

Option	Description
host	The URL to your Mealie instance. REQUIRED Type: string Example: "https://mealie.yourdomain.com" Default value: none
apiKey	An API key generated from a user profile in Mealie. REQUIRED Type: string Example: "eyhJbcG..." Default value: none Note: You can generate a key by going to your user profile in Mealie then to API Tokens link (or using this path /user/profile/api-tokens).
shoppingListID	The UUID of the shopping list you'd like to display.
updateInterval	The time in seconds when the shopping list should be updated. Type: integer Example: 300 (The shopping list will be refreshed every 5 minutes.) Default value: 60 (1 minute) Unit: seconds

Here is an example of an entry in config.js. Take note of mealTypeName and mealSortOrder. Here, we use the side meal type as a reminder of things we need to do to prepare for future meals, e.g., thaw meat. mealTypeName changes what appears, and mealSortOrder moves the side entries to the top of the list for each day.

{
    module: "MMM-MealieShoppingList",
    header: "Grocery List",
    position: "top_left",
    config: {
        apiKey: "eyhJbcG...",
        host: "https://mealie.example.com",
        shoppingListID: "4e9a8747-f4cd-4403-845e-6e0ba471b76d" // Change me with your shopping list ID
    }
},

Special Thanks

• Joshua Clark for creating the project MMM-MealieMenu, for which this project is heavily based on.
• Michael Teeuw for creating the project MagicMirror². You can sponsor the MagicMirror² project on their donate page.