Skip to content

Navigate Flavor Frontiers! A fun app to get recipies and tutorial videos ๐Ÿ”

Notifications You must be signed in to change notification settings

TuuPuu/dish-discovery

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

67 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

DishDiscovery

Navigate Flavour Frontiers! A fun app to get recipes and tutorial videos

Table of Contents


Expectations


With your team, you'll conceive and execute a design that solves a real-world problem by integrating data received from multiple server-side API requests. You will also continue to learn about agile development methodologies to help you work collaboratively. You will implement feature and bug fixes using git branch workflow and pull requests. You will write your own user stories and acceptance criteria in GitHub Issues to help your team stay on track with the project. Using GitHub Project as a means to track the status of your project tasks will help you understand the benefits of Kanban boards.

Learning Objectives


  • Speak technically about a feature you implemented in your project
  • Explain and execute git branching workflow in a collaborative project
  • Resolve merge conflicts
  • Explain agile software development
  • Design, build, and deploy a client-side web application using GitHub Pages
  • Prepare a professional presentation and repository README for your project

    Tools


    The following tools are to be used in this project:

    1. HTML and CSS
    2. Bootstrap
    3. Take input from a user and respond from that input
    4. Modals
    5. Client-side storage
    6. Responsive. When the web-page is resized the site responds accordingly
    7. the two server side API we used are Youtube AI and TheMealDB API

    Project Description


    The Dish Discovery Project is a fun food web application designed to help users explore new recipes and cooking ideas, watch easy related videos and save their favourite searches.

    The main motivation behind Dish Discovery is to inspire culinary creativity and make the process of finding new and exciting recipes more accessible.

    The project was built to address the common challenge of deciding what to cook by providing a user-friendly interface for discovering, exploring, and saving recipes.

    It aims to solve the problem of monotony in cooking and meal planning by offering a diverse range of recipes for users to try.

    During the development of this project, valuable insights into web development, API integration, and user experience design were gained. Additionally, skills in handling asynchronous requests and data manipulation were honed.

    Methodology


    This application is a single page web-application. It will ask the user for an input of a recipe of their choice. Once they click search it will populate a recipe and a youtube video linked to the recipe they have found. The user will also have the ability to add their recipe's to favourites, just so they can do a quick view on the recipe when needed.

    Below is our approach to this task:

    1. We split the task up so that each group member is assigned a task.
    2. Planning and SetUp
    3. Simple Front End Dev
    4. API Integration
    5. Local Storage and Modal
    6. Modal finalisation & Debugging
    7. Documentation and Debrief

    Conclusion


    Overall, we as a group felt we were put to our paces for this challenge. The main difficulties we faced were with the both APIs. But as tikto has mentioned documentation is the key to get out any mess. Documentation was one of the key reasons as to why we managed to pull it through this project.

    Future Improvements


    As a group we worked really well together. No issues were faced. However, there somethings we could improve on:

    1. When merging the branches on github we should've kept certain things constant. For example, the API keys and URL. By not keeping this constant it led to many conflicts and in the end we had to manually add our work to the main branch which is not efficient.
    2. Use a different video API as youtube kept hitting its daily usage limit very quickly.
    3. Something out of the blue could be to implement docker, node and nginx. Docker so we can containerise the application so its easy to deploy if we decide to go to live with this project. Ngix would be a server for hosting the application. Node would be used for javascript.

    Website Preview


    Wireframe Screenshot

    Application Screenshot 1

    Application Screenshot 2

    Application Screenshot 3

    Installation


    To run the Dish Discovery Project locally, follow these steps:

    Clone the repository to your local machine. Navigate to the project directory. Open the index.html file in a web browser.

    Repo can be accessed here:

    https://github.com/TuuPuu/dish-discovery

    Deployed site can be accessed here:

    https://tuupuu.github.io/dish-discovery/

    Usage


    • Enter your desired dish or cuisine in the search bar.
    • Click on the "Search" button to retrieve recipe suggestions.
    • Explore the displayed recipe instructions, ingredients and related video
    • Save your favorite recipes using the "Add to Favorites" button.

    Collaborators


    1. Hitesh Patel - Github Profile
    2. Elora Ainoa - Github Profile
    3. Omar Ibrahim - Github Profile
    4. Celia Chan - Github Profile

    Licenses


    This project is licensed under the MIT License.

  • About

    Navigate Flavor Frontiers! A fun app to get recipies and tutorial videos ๐Ÿ”

    Topics

    Resources

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

    No packages published

    Contributors 4

    •  
    •  
    •  
    •