User Manual Document Demo 3 - 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 or create an account
navigate between the main app areas
configure personal preferences, equipment, allergies, and measurement units
manage pantry ingredients
discover recipes and use Guided Discovery
view recipes and nutritional information
organise recipes and external links in a Vault
manage shopping lists
browse previously saved content while offline
access in-product help and support

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 five main navigation options are:

Home — opens the main dashboard and personalised suggestions
Swipes — opens Guided Discovery
Discover — displays recipe categories and browsing options
Vault — opens saved recipes, shared collections, and external links
Pantry — displays and manages the ingredients the user has available

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

To open an area, tap its icon or label. The currently selected area is highlighted in burgundy. The Preference Profile and Help & Support pages are accessed through the account and help controls rather than through separate bottom-navigation items.

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

Open the app and sign in.
Select Home from the bottom navigation bar.
Browse the recommended recipe discovery options shown on the screen.
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

Open the app and sign in.
Select Discover from the bottom navigation bar.
Browse the available recipe categories, such as Italian, Japanese, Indian, Mexican, and Chinese.
Use the filter options, such as Favourites, History, Following, and Trending, to change the type of recipes shown.
Tap a recipe card to view more details about that recipe.
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

Open the app and sign in.
Select Pantry from the bottom navigation bar.
Use the search bar to look for a specific ingredient.
Select a category filter, such as Proteins, Vegetables, or Dairy, to narrow down the pantry items.
Review each ingredient’s quantity, storage details, and freshness status.
Use the edit icon on an ingredient card to update its quantity or unit.
Use the delete icon to remove an ingredient from the pantry.
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

Open the Pantry page or the Home Dashboard.
Select the plus button to open the Add Ingredient page.
Enter the ingredient name.
Select the ingredient category, such as Produce, Dairy, Meat, or Grains.
Enter the quantity and unit.
Add the price paid, if available.
Use the Mark as out of stock option if the ingredient should remain listed but not count as currently available.
Select Save Ingredient to add the item to the pantry.
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 allows users to personalise how Mealchemy selects and displays recipes. Users can choose a preferred measurement system, record the equipment available in their kitchen, manage critical allergies and ingredient aversions, select favourite cuisines, and specify nutritional goals.

These choices are used to improve recipe matching and personalise recommendations throughout the application.

Users can access the Preference Profile by selecting the account/profile icon from the Home screen.

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

How to Use the Preference Profile

Open the app and sign in.
Select the account/profile icon from the Home screen.
Under Preferred Units, choose Metric or Imperial.
Under Your Kitchen, add or remove equipment such as an oven, stovetop, microwave, air fryer, or blender.
Under Critical Allergies, add ingredients that must always be excluded.
Under Aversions, add ingredients that should be avoided in recommendations.
Under Flavour Profiles, select the cuisines the user prefers.
Under Nutritional Goals, select goals such as High Protein.
Review the saved-status indicator to confirm that the changes have been stored.

Preference changes are saved automatically and are used to personalise recipe recommendations and measurements across the app.

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

Guided Discovery

Guided Discovery helps users explore personalised recipes through an interactive swipe-style experience. Each recipe card displays a match percentage, preparation time, missing pantry ingredients, and filtering options.

Users can like recipes that interest them, skip recipes that are unsuitable, or open a full preview before deciding. These interactions, together with pantry contents and saved preferences, help Mealchemy improve future recommendations.

Users can access Guided Discovery by selecting Swipes from the bottom navigation bar.

Figure 10: Integrated Guided Discovery showing a recommendation card and expanded recipe preview.

How to Use Guided Discovery

Open the app and sign in.
Select Swipes from the bottom navigation bar.
Use filters such as All, Quick Meals, High Protein, or Vegetarian to narrow the recommendations.
Review the recipe’s match percentage, preparation time, and missing pantry ingredients.
Swipe right or select the heart button to like a recipe.
Swipe left or select the cross button to skip a recipe.
Select the centre button to move to the next recommendation where applicable.
Select View Full Recipe to open the recipe preview.
Review the recipe description, preparation time, cooking time, total time, serving count, and explanation of why the recipe matches the user.
Continue browsing until a suitable recipe is found.

Guided Discovery is useful when users are unsure what to cook and want recommendations shaped by their pantry, preferences, and previous interactions.

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

Open the app and sign in.
Select Vault from the bottom navigation bar.
Use the Vault selector to switch between the user’s Private Vault and available Shared Vaults.
Expand a recipe folder to view its saved recipes.
Select Add More Folders to create another folder.
Use the plus button to add a recipe or external link.
Expand My Links to view recipes saved from external websites.
Select an external link to open its original website.
Use the edit icon to update a saved link.
Use the delete icon to remove a saved link.
Use the three-dot menus to access additional folder or Vault actions.

The Vault gives users one organised location for recipes created inside Mealchemy and recipes discovered on external websites.

The Vault allows users to organise saved recipes and external recipe links. Users can manage a private Vault, participate in shared Vaults, arrange recipes into folders, and keep recipes from external websites in the My Links folder.

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

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

Open the app and sign in.
Select Vault from the bottom navigation bar.
Open the vault selector and choose Shared Vaults.
Select Add Vault to create a new shared vault.
Open an existing shared vault to view its folders and recipes.
Add folders to organise recipes inside the shared vault.
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.

How to Use Recipe Details

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

How to View Nutritional Information

Open a recipe.
Select the Nutrition tab.
Review the recipe’s serving count and total calories.
Select Per Recipe to view nutritional values for the complete recipe.
Select Per Serving to view nutritional values for one serving.
Review the macronutrient values for protein, carbohydrates, and fat.
Scroll down to view fibre and sodium under Other Nutrients.
Expand an ingredient under Ingredient Breakdown to see its nutritional contribution.
Review the USDA disclaimer at the bottom of the page.

Nutritional values are estimates based on data provided by USDA FoodData Central and may not be completely accurate.

The Recipe Details page connects recipe instructions, nutritional information, serving adjustments, shopping-list generation, and guided cooking in one place.

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

Open the app and sign in.
Open the Shopping Lists page.
View the available shopping lists.
Select the plus button to create a new shopping list.
Tap a shopping list to open its items.
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

Open the Shopping Lists page.
Select a shopping list to view its items.
Tick an item when it has been purchased.
Select Select all to mark all items as purchased.
Select Deselect to clear selected items.
Use the plus button to add another item to the list.
Use the menu icon to access item actions.
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

Open a recipe from Discover, Vault, or another recipe list.
Review the recipe ingredients.
Select the shopping cart icon at the top of the recipe page.
Wait for the confirmation message.
Open the Shopping Lists page.
Select the newly created shopping list.
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

Select the help icon from the application header.
Select Contact Support to view support contact information and availability.
Select Report a Problem to see how to report a bug or incorrect recipe.
Expand Getting to know your Pantry for Pantry guidance.
Expand Vaults or Saving External Recipe Links for help organising recipes and links.
Expand Guided Discovery for help using recipe swipes.
Expand Understanding Nutrition for guidance on recipe nutritional values.
Expand Using Mealchemy Offline to learn which functionality remains available without a connection.
Open the remaining Navigation Guide topics for recipe and Shopping List assistance.
Review Frequently Asked for answers to common questions.

Each Help row can be expanded or collapsed so users can read only the guidance they need.

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

Offline Access

Mealchemy provides read-only access to previously saved data when the backend cannot be reached. An offline banner appears at the top of the screen to make it clear that the user is viewing cached information.

While offline, users can browse previously saved recipes, Vaults, Discover content, Pantry items, and Shopping Lists. Cache-freshness information indicates when content was last saved.

Actions that change server data are unavailable offline. This prevents unsynchronised edits and protects the consistency of the user’s data.

Figure 18: Offline mode showing the global banner, cached browsing, cache freshness, and protected mutation routes.

How to Use Mealchemy Offline

Use Mealchemy while online so supported content can be saved to the device.
If the backend becomes unreachable, look for the Offline – showing saved data banner.
Continue browsing previously saved recipes, Vaults, Discover content, Pantry items, and Shopping Lists.
Look for freshness information, such as Saved 5m ago, to understand when cached content was last updated.
Use available search, category-filter, navigation, and recipe-viewing functionality.
Return online before attempting to create, edit, delete, favourite, check, or update data.
If a protected add or edit route is opened offline, Mealchemy displays a message explaining that changes are unavailable.
After connectivity is restored, wait for the offline banner to disappear before continuing with changes.

Offline content is scoped to the signed-in user. Signing in as a different user switches to that user’s saved data.