User Manual Document Demo 2 - COS301-SE-2026/Mealchemy GitHub Wiki

Introduction

Mealchemy is a meal-planning and recipe management application that is designed to help users make smarter meal decisions by reducing meal-time decision fatigue. This app allows users to manage ingredients, set dietary and personal preferences, discover recipes through recommendations and dashboards, and organise shopping lists.

This manual explains each main feature of our app using clear instructions and screenshots to ensure users can follow with ease.

This manual covers how to:

  • sign in to the app
  • set personal preferences
  • manage pantry ingredients
  • discover recipes
  • store recipes in a vault
  • use guided recipe discovery
  • manage shopping lists

Getting Started

This section explains how to open Mealchemy and begin using the app.

Opening the App

When the user opens the Mealchemy app, they are taken to the welcome and login screen. From here, they can either log in with an existing account or create a new account.

Figure 1: Mealchemy welcome and login screen.

Signing In

To sign in, the user enters their email address and password, then selects the 'Log In' button. After successfully logging in, the user is redirected to the main app area.

Figure 2: Login form where users enter their email address and password.

Creating an Account

New users can create an account by selecting the 'Create Account' button. They will be asked to input their personal details before accessing the app.

Figure 3: Create Account screen for creating a new Mealchemy account.

After signing in or creating an account, users can begin exploring the main features of Mealchemy. This includes the pantry, preferences, recipe discovery, recipe vault, and shopping lists.

App Navigation

Mealchemy uses a bottom navigation bar to help users move between the different components and features of the app. The navigation bar stays at the bottom of the screen so users can quickly switch between pages.

The main navigation options are:

  • preference profile
  • dashboard
  • guided discovery
  • pantry
  • vault (private, shared, global)
  • recipe management
  • shopping list

Figure 4: Bottom navigation bar used to move between the main app sections.

To open a section, users tap the matching icon or label in the bottom navigation bar. The selected section is highlighted so users can see where they are in the app.

Feature Walkthroughs

This section explains the main features available in Mealchemy. Each feature includes a short description, basic steps, and screenshots to help users understand how to use the app.

Dashboard

The Dashboard is one of the main starting points in Mealchemy. It helps users browse recipe-related content and move into discovery features such as Guided Discovery.

Users can access this page by selecting Home from the bottom navigation bar.

Figure 5: Dashboard where users can begin exploring recipes.

How to Use the Dashboard

  1. Open the app and sign in.
  2. Select Home from the bottom navigation bar.
  3. Browse the recommended recipe discovery options shown on the screen.
  4. Select a recipe or discovery option to view more details.

From the Dashboard, users can view recommended recipes, open recipe details, and manually add ingredients to their pantry.

The Guided Discovery feature can also be accessed from the Dashboard area. This feature is explained later in the manual.

Discover

The Discover page allows users to explore recipe recommendations and browse different meal ideas. Users can view popular categories, filter recipe content, and open recipe cards for more information.

Users can access this page by selecting Discover from the bottom navigation bar.

Figure 6: Discover page showing recipe categories and recommended meal ideas.

How to Use Discover

  1. Open the app and sign in.
  2. Select Discover from the bottom navigation bar.
  3. Browse the available recipe categories, such as Italian, Japanese, Indian, Mexican, and Chinese.
  4. Use the filter options, such as Favourites, History, Following, and Trending, to change the type of recipes shown.
  5. Tap a recipe card to view more details about that recipe.
  6. Select View All to see more recipes in a selected section.

The Discover page helps users find meal inspiration by showing recipe ideas across different categories and cuisines.

Pantry

The Pantry page helps users keep track of the ingredients they currently have. Ingredients are grouped by category, such as proteins, vegetables, and dairy. Each item shows useful details such as quantity, storage notes, and freshness status.

Users can access this page by selecting Pantry from the bottom navigation bar.

Figure 7: Pantry overview showing ingredient categories and freshness information.

How to Use the Pantry

  1. Open the app and sign in.
  2. Select Pantry from the bottom navigation bar.
  3. Use the search bar to look for a specific ingredient.
  4. Select a category filter, such as Proteins, Vegetables, or Dairy, to narrow down the pantry items.
  5. Review each ingredient’s quantity, storage details, and freshness status.
  6. Use the edit icon on an ingredient card to update its quantity or unit.
  7. Use the delete icon to remove an ingredient from the pantry.
  8. Select the plus button to add a new ingredient.

Add Ingredient

The Add Ingredient page allows users to manually add ingredients to their pantry. This helps Mealchemy keep pantry information up to date and improves recipe matching.

Users can access this page by selecting the plus button from the Pantry page or from the Dashboard pantry card.

Figure 8: Add Ingredient page where users enter ingredient details.

How to Add an Ingredient

  1. Open the Pantry page or the Home Dashboard.
  2. Select the plus button to open the Add Ingredient page.
  3. Enter the ingredient name.
  4. Select the ingredient category, such as Produce, Dairy, Meat, or Grains.
  5. Enter the quantity and unit.
  6. Add the price paid, if available.
  7. Use the Mark as out of stock option if the ingredient should remain listed but not count as currently available.
  8. Select Save Ingredient to add the item to the pantry.
  9. Select Cancel to return without saving.

Keeping the pantry updated helps Mealchemy suggest recipes that better match the ingredients users already have.

Preference Profile

The Preference Profile page allows users to personalise their Mealchemy experience. Users can set dietary preferences, allergies, disliked ingredients, and flavour profiles. These choices help Mealchemy tailor recipe suggestions to the user’s lifestyle and food preferences.

Users can access this page by selecting Profile from the bottom navigation bar.

Figure 9: Preference Profile screen showing dietary directives and allergy options.

How to Use the Preference Profile

  1. Open the app and sign in.
  2. Select Profile from the bottom navigation bar.
  3. Review the available dietary directives.
  4. Select any dietary directive that applies, such as Celiac Friendly / Gluten-Free.
  5. Add or remove critical allergies, such as Peanuts or Shellfish.
  6. Add ingredients the user dislikes under Aversions & Dislikes.
  7. Select one or more flavour profiles that match the user’s taste preferences.
  8. Select Update Profile to save the changes.
  9. Select Reset All Directives to return the profile options to their original state.

Selected options are highlighted so users can easily see which preferences are currently active.

Guided Discovery

Guided Discovery helps users discover recipes through a swipe-style interface. The app shows one recipe at a time, and users can either like or skip the recipe. These choices help Mealchemy understand the user’s taste preferences. A right swipe indicates a like, and a left swipe indicates a dislike to the recommended recipe. This future integrated feature will take into account the user's likes and dislikes.

At the end of the Guided Discovery session, Mealchemy gives a recommendation based on the recipes the user liked or skipped.

Users can access Guided Discovery from the Dashboard.

Figure 10: Guided Discovery screen where users can like or skip recipe recommendations.

How to Use Guided Discovery

  1. Open the app and sign in.
  2. Go to the Dashboard.
  3. Open the Guided Discovery feature.
  4. Review the recipe card shown on the screen.
  5. Swipe right or select the heart button to like a recipe.
  6. Swipe left or select the cross button to skip a recipe.
  7. Use the filter chips, such as Quick Meals, High Protein, or Vegetarian, to narrow down the recipe options.
  8. Select View Full Recipe to see more details about a recipe.
  9. Continue liking or skipping recipes until the session is complete.
  10. Review the final recommendation generated from the user’s choices.

Guided Discovery is useful when users are unsure what to cook and want Mealchemy to suggest recipes based on their reactions.

Vault

The Vault page allows users to organise saved recipes into different vault areas. Users can view their private vault, shared vaults, and recipe folders. This helps users keep personal recipes separate from recipes shared with other users.

Users can access this page by selecting Vault from the bottom navigation bar.

Figure 11: Vault screens showing private and shared vault views.

How to Use the Vault

  1. Open the app and sign in.
  2. Select Vault from the bottom navigation bar.
  3. Use the vault selector to switch between Private Vault and Shared Vaults.
  4. View existing recipe folders in the selected vault.
  5. Select Add More Folders to create a new folder.
  6. Use the plus button to add recipes or vault content.
  7. Use the menu icon on a folder or vault section to access more actions.

The Vault helps users organise recipes by ownership, folder, and sharing context.

Shared Vaults

Shared Vaults allow users to create and manage recipe spaces that can be shared with other users. This feature supports collaborative recipe storage and makes it easier for households, families, or groups to manage shared recipes.

Users can access shared vaults from the Vault page by selecting Shared Vaults from the vault selector.

Figure 12: Shared Vault view showing a shared recipe vault.

How to Use Shared Vaults

  1. Open the app and sign in.
  2. Select Vault from the bottom navigation bar.
  3. Open the vault selector and choose Shared Vaults.
  4. Select Add Vault to create a new shared vault.
  5. Open an existing shared vault to view its folders and recipes.
  6. Add folders to organise recipes inside the shared vault.
  7. Use the menu icon to access shared vault actions.

Shared Vaults are useful when users want to manage recipes together with other users.

Recipe Details

The Recipe Details page displays the full information for a selected recipe. Users can view the recipe overview, ingredients, preparation steps, and nutrition information. From this page, users can also start cooking, save the recipe, or create a shopping list from the recipe.

Users can access this page by selecting a recipe from the Discover page, Vault, or another recipe list.

Figure 13: Recipe Details page showing recipe information for Tacos.

How to Use Recipe Details

  1. Open a recipe from Discover, Vault, or another recipe list.
  2. Review the recipe overview, including cook time and prep time.
  3. Select the Ingredient tab to view ingredients.
  4. Select the Steps tab to view preparation instructions.
  5. Select the Nutrition tab to view nutritional information.
  6. Select the shopping cart icon to generate a shopping list from the recipe.
  7. Select the bookmark icon to save the recipe.
  8. Select Start Cooking when ready to begin cooking.

The Recipe Details page gives users all the information they need to prepare a recipe and connect it to other Mealchemy features.

Shopping Lists

The Shopping Lists page allows users to view and manage multiple shopping lists. Users can create new lists manually, open existing lists, and access list actions from the menu.

Users can access this page by selecting the shopping cart icon or by opening shopping lists from the app navigation.

Figure 14: Shopping Lists page showing one or more shopping lists.

How to Use Shopping Lists

  1. Open the app and sign in.
  2. Open the Shopping Lists page.
  3. View the available shopping lists.
  4. Select the plus button to create a new shopping list.
  5. Tap a shopping list to open its items.
  6. Use the menu icon next to a list to access list actions, such as editing or deleting the list.

Shopping Lists help users organise ingredients they need to buy and keep different shopping trips separate.

Shopping List Items

The Shopping List detail page shows the items inside a selected shopping list. Items are grouped by ingredient category and can be selected when they have been purchased. Users can select all items, deselect items, delete selected items, or send selected items to the pantry.

Users can access this page by selecting a shopping list from the Shopping Lists page.

Figure 15: Shopping List detail page showing item selection and pantry update.

How to Use Shopping List Items

  1. Open the Shopping Lists page.
  2. Select a shopping list to view its items.
  3. Tick an item when it has been purchased.
  4. Select Select all to mark all items as purchased.
  5. Select Deselect to clear selected items.
  6. Use the plus button to add another item to the list.
  7. Use the menu icon to access item actions.
  8. Select Update Pantry to send selected purchased items to the pantry.

After selected items are sent to the pantry, the app confirms how many items were transferred.

Automatic Shopping List from Recipe

Mealchemy can create a shopping list from a recipe. This allows users to move from meal planning into shopping without manually typing every ingredient. When a shopping list is generated, the app creates a new list using the recipe’s ingredients.

Users can generate a shopping list from the Recipe Details page.

Figure 16: Recipe Details page confirming that a shopping list was created for a recipe.

How to Create a Shopping List from a Recipe

  1. Open a recipe from Discover, Vault, or another recipe list.
  2. Review the recipe ingredients.
  3. Select the shopping cart icon at the top of the recipe page.
  4. Wait for the confirmation message.
  5. Open the Shopping Lists page.
  6. Select the newly created shopping list.
  7. Review the generated items and update them as needed.

This feature helps users quickly turn a recipe into a shopping list and reduces the need for manual list creation.

Help & Support

The Help & Support page provides users with guidance on how to use Mealchemy. It includes support contact details, a problem reporting section, navigation guides for key app features, video tutorial access, and frequently asked questions.

Users can access this page from the app’s help or support area.

Figure 17: Help & Support screens showing support options and navigation guides.

How to Use Help & Support

  1. Open the Help & Support page.
  2. Select Contact Support to view support contact information.
  3. Select Report a Problem to see how to report bugs or incorrect recipe information.
  4. Open the Navigation Guide sections to learn how to use features such as Pantry, Vaults, Recipes, and Shopping Lists.
  5. Use the Video tutorials section for additional help.
  6. Review the frequently asked questions for common app guidance.

The Help & Support page makes it easier for users to understand the app and find assistance when something is unclear or not working correctly.