Giter VIP home page Giter VIP logo

chingu-voyages / v46-tier2-team-15 Goto Github PK

View Code? Open in Web Editor NEW
2.0 5.0 1.0 7.08 MB

DishDive is an innovative web application that simplifies the process of finding recipes based on the ingredients you have on hand. Whether you're looking to whip up a quick meal with whatever's in your kitchen or seeking culinary inspiration, DishDive has you covered.

Home Page: https://dishdivev46tier2team15.netlify.app/

HTML 3.43% CSS 10.01% JavaScript 86.56%
2023 chingu-voyage css3 edamam-recipe-api html5 reactjs recipe-website responsiveness tailwindcss

v46-tier2-team-15's Introduction

DishDive ๐Ÿฝ๏ธ

Discover delightful recipes with DishDive, your go-to recipe search app! Whether you're a cooking enthusiast or just looking for a quick meal idea, DishDive has you covered.

๐Ÿš€ Features

Ingredient Magic: Find recipes based on the ingredients you have in your kitchen.

Responsive Delight: Enjoy a seamless experience on both your phone and desktop.

Day or Night Mode: Switch between light and dark themes for optimal browsing.

Share the Love: Spread the joy by sharing your favorite recipes on social media.

Sort & Savor: Easily sort and filter recipes to find your perfect match.

๐Ÿ“ธ Screenshots

image

image

image

๐ŸŒ Demo

Check out the live demo here.

๐Ÿ› ๏ธ Built with

React

v46-tier2-team-15's People

Contributors

darshan-pandya10 avatar drazen-thegrc avatar fayiz770 avatar jdmedlock avatar petre4488 avatar teodora-kocic avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

abdullahsadik00

v46-tier2-team-15's Issues

Optimization

User Story Description
As a user,

I want the website to be well optimized,

So that i can navigate through it without waiting too much for it to load.

Acceptance Criteria:

Implement optimization techniques to ensure fast loading times and smooth performance of the website.

Optimize images, scripts, and other assets to reduce page load times.

Implement caching mechanisms to improve website responsiveness for returning users.

Utilize compression techniques to minimize file sizes and reduce bandwidth usage.

Conduct performance testing to ensure that pages load within acceptable timeframes.

Monitor and analyze website performance regularly to identify and address any potential bottlenecks or issues.

Ensure that the website is optimized for a variety of devices and browsers to provide a consistent and responsive user experience.

Getting Started: ๐Ÿค” Start thinking about project ideas & the technical stack

Task Description

  • Check out apps that Voyage teams have created in prior Voyage by reviewing the Project Showcase
  • Come up with 1 to 3 ideas for projects you'd like to build so you can discuss them with the rest of the team when the Voyage starts.
  • Think about what technical stack you'd like to use to build that app. Similarly, you'll discuss this as a team at the start of the Voyage.

Technical Considerations
N/a

Additional Considerations
N/a

Resources
Choose a project & create a Vision Statement (Chingu Handbook)

Member of Epic: #15

Search Input Clearance

User Story Description
As a user,

I want the search input to be cleared after a successful search,

So that the page will look cleaner and improve UX.

Acceptance Criteria:

Clear the search input field after a successful search operation.

Ensure that the cleared input field is visually empty, providing a clean and uncluttered interface.

Additional Recipe Info

User Story Description
As a user,

I want to see additional information about the selected recipe,

So that i can read more about the recipe i m looking for

Acceptance Criteria:

Display additional information about the selected recipe, including name, category, list of instructions, nutrition, and cooking time.

Ensure that this information is presented in a clear and organized manner.

Landing Page Behavior

User Story Description
As a user,

I want to stay on the landing page if no search ingredient has been entered and see an error message,

So that I will understand that I need to provide search criteria to use the app effectively.

Acceptance Criteria:

If no search ingredient has been entered, keep the user on the landing page.

Display an error message or instructional message informing the user to provide search criteria.

Recipe Display

User Story Description
As a user,

I want to see each recipe in the main component,

So that I can easily find the recipe I'm looking for.

Acceptance Criteria:

Each recipe displayed in the main component should include a clear and high-quality image of the prepared dish.

Ensure that the recipe's image is visually appealing and representative of the dish's appearance.

The recipe card should prominently feature the recipe's name, making it easily readable and identifiable.

Include a clickable link or button within the recipe card that allows users to access more details about the recipe.

Verify that the layout of recipe cards is consistent, providing a uniform and organized presentation of recipes.

Getting Started: ๐Ÿ™‹ Do you have questions about Chingu or the Voyage process?

Task Description
If you have questions about Chingu or the Voyage process join one or both of the Chingu Roundtable sessions held every:

  • Wednesday @ 2:00 p.m. GMT -6 (Chicago)
  • Saturday @9:00 a.m. GMT -6 (Chicago)

These sessions give you the opportunity to ask your questions in real time with a member of the Chingu team

Technical Considerations
These are held in our Discord community in the #townhall-chat & #townhall-voice channels.

Additional Considerations
You may also ask questions anytime in the #admin-feedback channel in Discord or by opening a support ticket in the #open-support-ticket channel.

Member of Epic: #15

Readme

User Story Description
As a PO,

I want our app to have a good looking readme that shows info about the page,

So that users will know that features our app has.

Acceptance Criteria:

Ensure that the readme.md file on Github include all features

Include a well-designed styling for the text so that users will be more engaged while reading it

Include infos about the team members like: linkedIn, github profiles

Include a members presentation with characters that represent them (AI generated)

Include our project vision and workflow throughout the project

Step 4: ๐Ÿ“ค Define & prioritize MVP features

Task Description

  • Each team member should add their ideas to the Project Vision & Feature Planning template before the team meeting
  • Prioritize each feature - Must Have, Should Have, Nice to Have
  • Meet with the team to review each feature & refine priorities

Technical Considerations
N/a

Additional Considerations
All Must Have tasks will make up your MVP. Make sure that you control the scope of the project by limiting the number of Must Have features to the ones you can reasonably complete by the end of Sprint 6.

Remember that you can always add new features once you complete the MVP.

Resources
Choose a Project & create a Vision Statement (Chingu Handbook)
Define & Prioritize MVP features (Chingu Handbook)

Member of Epic: #16

Step 7: โš™๏ธ Set Up a Team Workflow

Task Description

  • Decide on the coding standards the team must follow.
  • Define the characteristics of your repo including the number of branches, branch names, & the workflow everyone must follow.
  • Agree on the format of commit messages, how Pull Requests will be reviewed, and GitHub branch protection rules.
  • Decide on where youโ€™ll deploy your app and the branch to be considered as โ€˜productionโ€™ youโ€™ll be deploying from.
  • Decide on what meetings youโ€™ll need each week and to save time, schedule them as recurring meetings. You might want to look ahead to Reaching your MVP to learn more about the types of meetings youโ€™ll need.

Technical Considerations
N/a

Additional Considerations
Setup Your Team Workflow (Chingu Handbook)
Javascript Style Guides
Defining a Git Workflow (Chingu Handbook)
Git Branches (Chingu Handbook)
Git Pull Requests (Chingu Handbook)

Member of Epic: #16

App Tutorial

User Story Description
As a new user,

I want to learn how to use the feature that the app provides,

So that i can use it more efficiently

Acceptance Criteria:

Display two clear sections in the About page, one of them being โ€œAbout teamโ€œ and the other being โ€œTutorialโ€œ.

Display the information clear for the users.

Favorite Recipe

User Story Description
As a user,

I want the ability to save recipes as favorites,

So that i can easily find them later

Acceptance Criteria:

Implement the ability for users to save recipes as favorites, storing them locally.

Ensure that saved recipes are easily accessible to users.

Team Infos

User Story Description
As a new user,

I want to visit the "About" page to learn about the team behind the app and their mission, vision, and values,

So that i can learn about the team and workflow behind the app

Acceptance Criteria:

Display information about the team or organization behind the website.

Include details such as the mission, vision, and values of the team.

Header

User Story Description
As a PO,

I want to see a welcome message displayed on header,

So that users will know what the page is about

Acceptance Criteria:

Provide a good looking welcome header message

Include the app logo

Ensure that the message contain small advices on what the app is about

Search Trigger

User Story Description
As a user, I want to trigger the search action both on the Enter key and a search button/icon, so that i can search more comfortable

Acceptance Criteria:

Allow users to trigger the search action by pressing the Enter key when the search input is focused.

Provide a search button/icon that users can click to initiate the search.

Input Ingredients

User Story Description
As a user, I want to input one or more ingredients, so that I can search based on exactly what ingredients I have.

Acceptance Criteria:

Accept one or more ingredients as input

Pagination For Search Results

User Story Description
As a user,

I want the app to incorporate pagination for recipe search results,

So that I can navigate through a large number of search results.

Acceptance Criteria:

Incorporate pagination for recipe search results.

Allow users to navigate through multiple pages of search results using next/previous buttons or direct page selection.

Font Customization

User Story Description
As a PO,

I want users to have the ability to customize the font and font size,

So that users will have better readability.

Acceptance Criteria:

Provide users with options to customize the font and font size for better readability.

Include a user-friendly interface for font customization in the navbar

Video Playback

User Story Description
As a user,

I want the ability to watch a video for the selected recipe,

So that i can easily follow along while cooking.

Acceptance Criteria:

Allow users to watch a video related to the selected recipe.

Ensure that the video playback feature is functional and provides a seamless viewing experience.

The Voyage Process - Getting off to a Solid Start!

Feature Description
Chingu has created a process for you to follow during the Voyage. This process helps you to get off on a solid start.

Major User Stories/tasks

  • Step 1: ๐Ÿค Meet your team & schedule Kickoff meeting #5
  • Step 2: ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Conduct Kickoff meeting #6
  • Step 3: ๐Ÿ‘ Choose a project & create a Vision Statement #7
  • Step 4: ๐Ÿ“ค Define & prioritize MVP features #8
  • Step 5: ๐Ÿ“‹ Create a Project Backlog #9
  • Step 6: ๐Ÿ“ Create a Low-fidelity wireframe #14
  • Step 7: โš™๏ธ Set Up a Team Workflow #10

Additional Considerations
N/a

NavBar Component

User Story Description
As a user,

I want to have a navigation bar,

So that i can easily change pages and settings.

Acceptance Criteria:

Ensure the navbar appears on top of each page on the website

Provide a clearly labeled design for each of the navbar button

Verify the navbar responsiveness on various screen sizes, including desktop and mobile

Previous Session Criteria

User Story Description
As a user,

I want the ability to select search criteria from my previous sessions,

So that I can find recipes more easily.

Acceptance Criteria:

Allow users to select search criteria from their previous sessions.

Store and retrieve the last 5 searched criteria from local storage.

Step 2: ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Conduct Kickoff meeting

Task Description

  • Using everyone's availability posted to When2Meet schedule a Kickoff meeting
  • Use the Kickoff meeting template in the shared document directory we've provided to guide the discussion and to record notes, decisions, and assignments
  • Set a time for your next meeting for later in the week

Technical Considerations
N/a

Additional Considerations
N/a

Resources
Conduct Kickoff Meeting (Chingu Handbook)

Member of Epic: #16

Footer

User Story Description
As a PO,

I want to see a footer,

So that users can find our Github repo quickly.

Acceptance Criteria:

Implement a footer section at the bottom of every page on the website.

Include a clearly labeled and prominently positioned link or button in the footer that directs users to the website's GitHub repository.

Ensure that the GitHub link is functional and takes users directly to the project's GitHub repository page.

Provide a tooltip or hover effect that indicates the purpose of the GitHub link when users hover over it.

Ensure that the footer design is consistent across all pages of the website, maintaining a cohesive user experience.

Logo

User Story Description
As a user,

I want the website to have a distinctive and visually appealing logo prominently displayed at the top of every page,

So that the logo effectively represents the website s identity, branding, or theme.

Acceptance Criteria:

Ensure that the logo has a simple and well structured design

Ensure the logo represent our team and it covers the website theme and app

Sort and Filter Options

User Story Description
As a user,

I want the ability to sort and filter the search results,

So that I can easily find the most relevant recipe for me.

Acceptance Criteria:

Provide sorting and filtering options for search results.

Allow users to sort recipes by relevance, rating, time, and other relevant criteria.

Responsiveness

User Story Description
As a user,

I want the app to be responsive,

So that i donโ€™t have to keep my pc/laptop close while Iโ€™m cooking.

Acceptance Criteria:

The app should be responsive to mobile and desktop (1080ร—1920 and 1920x1080)

Wireframe

User Story Description
As a Developer,

I want to follow a low fidelity/high fidelity wireframe,

So that the app will be well designed and the whole designing process will be faster.

Acceptance Criteria:

Ensure that the wireframe follow all user-stories provided in the backlog

Ensure the wireframe contain a color palette for the whole website and logo

Ensure the styling design is well selected

Ensure the design wonโ€™t slow down the website performance

About Page

User Story Description
As a Product Owner,

I want to create an "About" page on our website,

So that users can learn more about our team and understand how to use the app effectively.

Acceptance Criteria:

Ensure that users can easily access the "About" page from the navbar.

Include a clear link or button in the navbar.
Additional Considerations
Any supplemental information including unresolved questions, links to external resources, screenshots, etc.

Error Message Unlisted Item

User Story Description
As a PO,

I want a message to be displayed when an unlisted item is entered,

So that users will know that we don't have recipes for that item.

Acceptance Criteria:

Display a clear and informative error message when users enter an ingredient that is not listed

The error message should be easily distinguishable, such as a highlighted text or an alert.

Social Sharing

User Story Description
As a user,

I want the ability to share my favorite recipes,

So that my friends can also cook the same recipe as me

Acceptance Criteria:

Provide the users with an intuitive Share Button

Ensure that the user can share on social media platforms like Instagram, Facebook and Twitter.

Step 5: ๐Ÿ“‹ Create a Project Backlog

Task Description

  • Watch the How to Create a Project Backlog video
    video link
  • Identify & prioritize features
  • Create an epic for each feature
  • Choose the highest priority epics & divide them into user stories
  • Add your epics & user stories to a backlog tool. You may use any project management tool your team prefers. For example, Jira, Miro, Zenhub, GitHub Projects, etc.
  • Prioritize the user stories

Technical Considerations
N/a

Additional Considerations
During the Voyage youโ€™ll refine the Project Backlog and in every Sprint youโ€™ll move tasks from it to the Sprint Backlog. This is part of the Agile process helps you and your team concentrate only on the tasks that must be completed in that Sprint.

If you are using ZenHub don't forget you'll need to install its browser extension before you can see the ZenHub tab in your GitHub repo.

Resources
Create a Project Backlog (Chingu Handbook)

Member of Epic: #16

List of Ingredients

User Story Description
As a user,

I want to see a list of ingredients for each recipe,

So that i will know if i need any more ingredients

Acceptance Criteria:

Display a list of ingredients for each recipe, including the names and units of measurement.

Ensure that the list is comprehensive and accurately reflects the recipe's ingredients.

Step 6: ๐Ÿ“ Create a Low-fidelity wireframe

Objective

Establish a common understanding across the team of what information is in each screen and the actions that may be invoked from each screen.

How

  • Using the features you added to the the Feature Planning template in step 4 identify the screens youโ€™ll need and the information on each one.
  • Map the actions users will be able to perform from each screen and the navigation from screen-to-screen
  • Create a low-fidelity wireframe using a tool like [Figma](https://www.figma.com/) or even pencil and paper.

Resources

How To Wireframe A Website in 3 Easy Steps
Create a low fidelity wireframe (Chingu Handbook)

Member of Epic: #16

Getting Started

Feature Description
Prepare for your Voyage by becoming familiar with the Chingu practices & procedures.

Major User Stories/tasks

  • Getting Started: ๐Ÿš€ Understand the Voyage Process #11
  • Getting Started: ๐Ÿ“œ Review the Chingu Agile Methodology #2
  • Getting Started: ๐Ÿค” Start thinking about project ideas & the technical stack #3
  • Getting Started: ๐Ÿ™‹ Do you have questions about Chingu or the Voyage process? #4

Additional Considerations
N/a

Step 1: ๐Ÿค Meet your team & schedule Kickoff meeting

Task Description

  • Meet your team by adding your introduction to the Team Channel
  • Start getting to know one another
  • Start discussing what projects you would like to create
  • Watch the Voyage Team Roles video to learn about the different roles members of your team may have signed up to fill.
    video link
  • Watch the How to Select a Voyage Project video
    video link

Technical Considerations
N/a

Additional Considerations
Meet Your team (Chingu Handbook)

Use When2Meet to identify days & times when everyone on the team is available to meet.

Member of Epic: #16

Dark and Light Mode

User Story Description
As a user,

I want the option to switch between dark and light mode for the website,

So that i can customize the app for my needs

Acceptance Criteria:

Implement a toggle switch in the navbar to allow users to switch between dark and light mode.

Ensure that the selected mode is applied consistently throughout the website.

Step 3: ๐Ÿ‘ Choose a project & create a Vision Statement

Task Description
Tier 1 & Tier 2 teams will be assigned a project. Tier 3 teams have the choice of creating a project from specifications provided by Chingu or choosing your own project. Check your team channel for more information on which project you are asked to complete.

For Tier 3 teams who choose to create their own project:

  • Watch the How to Select a Voyage Project video
    video link
  • Collect ideas from the team
  • Brainstorm with your team
  • Vote to select one idea
  • Decide on the technical stack youโ€™ll use to build your project

Technical Considerations
N/a

Additional Considerations
Use the Project Vision and Feature Planning template to gather & vote on everyone's idea

Resources
Choose a Project & create a Vision Statement (Chingu Handbook)

Member of Epic: #16

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.