paulh
/
recipe-manager
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
recipe-manager/docs/user-guide.md

3.1 KiB
Raw Blame History

Recipe Manager User Guide

This guide explains how to use Recipe Manager for day-to-day cooking and recipe organization.

What You Can Do

  • Add recipes manually
  • Edit or delete recipes
  • Organize recipes with tags
  • Search recipes by text
  • Use Cook Mode with step and ingredient checklists

Getting Started

  1. Open Recipe Manager in your browser.
  2. From the home page (Recipes), click + New Recipe to create your first recipe.

Create a Recipe

  1. Click + New Recipe.
  2. Fill in the required fields:
    • Title
    • Ingredients (one per line)
    • Instructions (one step per line)
  3. Optionally add:
    • Description
    • Source URL
    • Notes
    • Servings
    • Prep time and cook time
    • Tags
  4. Click Save Recipe.

Tips

  • Keep ingredient lines simple (example: 2 cups flour).
  • Keep instruction steps short and clear for easier Cook Mode tracking.

Browse and Search Recipes

On the Recipes page you can:

  • Scroll through recipe cards
  • Use the search box to find recipes by title, description, or ingredient text
  • Click Load More to view additional recipes when available

View, Edit, and Delete a Recipe

  1. Click a recipe card to open details.
  2. Use Edit to update any fields.
  3. Use Delete to remove the recipe permanently.

Deleting a recipe cannot be undone.

Manage Tags

Tags help you group recipes (for example: Dinner, Dessert, Quick, Vegetarian).

Add tags to a recipe

  1. Open a recipe detail page.
  2. Edit the recipe.
  3. Select existing tags (or create new ones if available in the tag selector).
  4. Save changes.

Remove tags

  • Edit the recipe and deselect the tag, then save.

Cook Mode

Cook Mode is designed for active cooking:

  1. Open a recipe.
  2. Click Cook Mode.
  3. Check off ingredients as you prep.
  4. Check off instruction steps as you complete them.
  5. Follow progress indicators until complete.

Screen Stay Awake

Cook Mode uses your browser’s Wake Lock support (when available) to keep your screen on while cooking.

If wake lock is not supported, the app still works normally.

Troubleshooting

I can’t save a recipe

  • Make sure title, ingredients, and instructions are not empty.
  • Check for network/server errors and try again.

I don’t see my latest changes

  • Refresh the page.
  • Verify the save completed successfully (look for confirmation toast).

Search is not finding a recipe

  • Try a simpler keyword from title, description, or ingredient lines.
  • Confirm the recipe was saved.

Keyboard and Mobile Usage

  • The interface works on desktop and mobile browsers.
  • In Cook Mode, controls are touch-friendly for kitchen use.

Privacy and Data

Recipe Manager is self-hosted for household use.

  • Your recipe data is stored in your own deployment database.
  • No external recipe-sharing account is required for MVP use.

MVP Feature Notes

Current MVP includes core recipe CRUD, search, tags, and cook mode.

Planned future features include:

  • Recipe web scraping/import
  • Advanced filtering
  • Serving-size scaling
  • Print-friendly layouts