Catalog Walkthrough
The Catalog feature is the bread & butter of Mealz. The Catalog is all of our Recipes, with additional features & options to filter, search, add dietary restrictions, & a whole lot more.
Time to read:
30 minutes
Time for base implementation:
2 hours
Time for custom implementation:
8 hours
Time for full customization:
2.5 weeks
Prerequisites
Packages
To have the Catalog functioning properly, you must install our packages mealz-core & mealz-android.
Here are the instructions
Initialize Mealz
Also, you must initialize Mealz in your MainActivity. Here are the instructions
if you are a provider or here if you are a supplier, if you don't know which configuration you need check here
Ingredients
There are two diffrent ways to add this component to your projet :
- basic implementation : an all-in-one compoment that embed navigation and all needed other components
- custom implementation : were you can handle navigation by yourself and link components that you need
The Catalog is made up of 8 base pages, with an additional 2 more being optional. Each page has its own functionality & is customizable, so that each component fits the appearance of your application.
Catalog Journey
Categories Page
The Categories Page, or CatalogView, is the landing page for our Catalog Feature.
This page shows different categories of recipes that are set & defined by your or our team in the Miam Studio.
A category is a list of recipes that have some theme, such as Halloween recipes or Vegetarian recipes.
Each list of recipes has a See All button that will navigate to that category in the CatalogResults Page.
Additionally, being the landing page, the header of the CatalogView contains the navigation to the other pages.
There are buttons to the Filters & CatalogSearch Page, & optionally the Preferences & PreferencesSearch Pages.
There is also a button to search for all the Recipes the user has favorited that are available at this specific location.
Because the recipes shown in the Catalog are only available at this store, these results will be different from the independent Favorites page.
A Call to Action for Mealz's Meal Planner feature can also be added to this page.
Catalog Results
The CatalogResults Page shows the recipe results from some sort of user action.
These actions are filtering, searching, or selecting a category.
The CatalogResults Page also has a header, but the Favorites Button is removed.
This is because the Favorites button also navigates to the Results page & we don't wish to provide a double navigation.
Filters
The Filters Page gives the user the option to sort by recipe difficulty, price per person, & time to cook.
As the user selects different options, the Call To Action button will update with the corresponding number of recipes available.
After the user selects the CTA, they will be navigated to the CatalogResults page & this page will be deleted from the navigation stack.
Catalog Search
The CatalogSearch Page gives the user the option to search for specific recipes or ingredients.
After the user selects the CTA, they will be navigated to the CatalogResults page & this page will be deleted from the navigation stack.
Recipe Details
The RecipeDetails Page shows the information, ingredients, & steps for the recipe.
Optionally, the user can add the item to their basket from the footer.
If the user adds the recipe to their basket, they are navigated to their Miam MyMeals or Basket.
Otherwise, they can just navigate back to the Page they launched from.
Sponsor Details
The SponsorDetails Page shows information about the product or company that is sponsoring a certain recipe.
The content comes from the Sponsor, so only the background, loader, & empty are customizable.
The user just navigates back to the Page they launched from.
My Meals
The MyMeals Page shows the recipes that the user has added to their basket.
Additionally, it includes the products that make up that recipe.
They can change the amount of products, change the product, or even change the number of guests.
The user just navigates back to the Page they launched from.
Item Selector
The ItemSelector Page shows other products that the user can replace their current product for.
When the user selects the product they are selecting, they should be navigated back to where they launched from.
Preferences - Optional
The Preferences Page gives the user the option to set restrictions on recipes based on certain criteria.
They can select by dietary restrictions, equipment, certain food items they dislike, & how many people they're cooking for.
After the user selects the CTA with their settings, they will be navigated back to the CatalogView page.
The page will reload with their settings & they will see the recipes corresponding to their settings.
Preferences Search - Optional
The PreferencesSearch Page gives the user the option to search up for certain food items they dislike.
For example, they may dislike mushrooms, so they can search for mushrooms & select that option.
From that point forward, recipes with mushrooms will not appear.
After the user selects food item from their search, they will be navigated back to the Preferences page.
Here, they can adjust their other settings.
Customization
If you would like to customize your components, such as the Empty, Loader, or RecipeCard, you can read our documentation here.
Next Steps
After integrating Catalog, you have the bulk of the Miam functionality in your android application.
However, we also have other features & standalones pages.
You can integrate a standalone MyMeals page, Favorites page, or our full feature Meal Planner.