CHANGE
cook it. will allow user to browse recipes. Create a meal plan. Start timers while they are cooking. Create a shopping list.
[Evaluation of your app across the following attributes]
- Category: Cooking
- Mobile: The app will be developed for mobile. All the functionality will be available on mobile devices. Currently there is no plan for the app to be available on Web of iOS.
- Story: App allows users to browse cooking recipes, see the ingeredients needed for a recipe and the instructions. Users can create shopping lists.
- Market: Anyone can choose to use this app.
- Habit: The app can be used any time the user wants to cook a meal, browse for a recipe, create a shopping list or go grocery shopping.
- Scope: The scope of original features is limitted. Users can use the app but cannot interact with other users. Down the line, user profiles can be integrated into the flow where users can save more about them, their favorite recipes, diet preferences and potentially interact with other users.
https://docs.google.com/presentation/d/18cQuoDQ6VRzbLvu2kpNJ06OXocNELWSpOut-MyYkDT8/edit?usp=sharing
Here's a walkthrough of implemented user stories:
Required Must-have Stories
- User can browse recipes
- User can start cooking timers
- User can create and edit shopping lists
- ...
Optional Nice-to-have Stories
- User can login
- User can register
- User can search for recipes
- User can favorite recipes
- User can add ingredients from recipe detail to the shopping list
- UI elements (Vector art, loading screens, etc)
- User can access profile with saved recipes
- ...
- Login [Optional]
- User can login
- Register [Optional]
- User can create an account
- Recipe Stream
- User can browse recipes
- User can favorite a recipe [Optional]
- Recipe Detail
- User can see more about a recipe
- User can add ingredients to the shopping list [Optional]
- User can favorite a recipe [Optional]
- Timer Fragment
- User can set a timer while cooking
- Shopping List Fragment
- User can view all the necessary ingredients
Tab Navigation (Tab to Screen)
- Recipe Stream
- Shopping List Creation
- Timer
- Search [Optional]
- Profile [Optional]
Flow Navigation (Screen to Screen)
- Recipe Stream
- Detail
- ...
- Timer
- Timer
- Shopping List
- Login [Optional]
- Recipe Stream
- Register [Optional]
- Recipe Stream
[Add picture of your hand sketched wireframes in this section]
Model: Recipe
| Property | Type | Description |
|---|---|---|
| recipeId | double | Unique id for the recipe |
| title | String | Name of the recipe |
| image | File | Picture of the recipe |
| servings | Number | Number of servings |
| readyInMinutes | double | Cooking time |
| ingredients | List | List of ingredients |
| instructions | String | Instructions to cook a meal |
| cuisine | List | List of cuisines associated with the recipe |
Model: Ingredient
| Property | Type | Description |
|---|---|---|
| name | String | Name of an ingredient |
| amount | double | Amount of an ingredient |
| unitShort | String | Abreviated units of an ingredient |
- [Add list of network requests by screen ]
- Recipe Feed Screen -- (Read/GET) Browse recipes to the feed and details of the recipes.
-
[Create basic snippets for each Parse network request] --Using API.
-
[OPTIONAL: List endpoints if using existing API such as Yelp]
-
Base Browse URL - https://api.spoonacular.com/recipes/random?number=20&apiKey=YOUR_API_KEY
-
Base Search URL - https://spoonacular.com/food-api/recipes/complexSearch
| HTTP Verb | Endpoint | Description |
|---|---|---|
| GET | /instructionsRequired | ensure the recipes includes instructions |
| GET | /maxReadyTime | filter by cook time |
| GET | /cuisines | filter by specific cuisine |
| GET | /diet | filter by specific diet |
| GET | /type | filter by meal type |
- Spoonacular: https://spoonacular.com/food-api/docs#Search-Recipes-Complex
- Spoonacular: supported cuisines: https://spoonacular.com/food-api/docs#Cuisines
- Spoonacular: supported diets: https://spoonacular.com/food-api/docs#Diets
- Spoonacular: supported meal types: https://spoonacular.com/food-api/docs#Meal-Types
- Previous HackMD doc, app ideas: https://hackmd.io/igNJdjSWQH-fUJo_HwWQRQ





