Git Product home page Git Product logo

whats-cooking's Introduction

resonse img

What's Cooking?

Code Institute Milestone Project 2

A responsive website used as a recipe search. Recipes can found using either a main ingredient, a meal or cuisine through an API. The user will also be able to search using specific requirements such as dietary needs, allergens and intolerance's. The site can be built upon further by adding more features in the future, which could make it a complete weekly planner for cooking and food shopping.

The live version can be found here

UX

The aim of the website is a recipe finder based on the user entering up to three details. The more specific the user is the better results will return.
This will give the user an easier way to find recipes based on their needs and wants

Target Users

  • Users looking for new recipes ideas
  • Users with specific allergies or intolerance's
  • Users interested in healthy food
  • Users looking for different international cuisines
  • Users looking new recipes based specific dietary requirements
  • Users new to cooking
  • Users that know how to cook
  • Users who may want to change their diet

User Stories

  • As a User I want a clean and clear Website
  • As a User I want to be able to navigate around the site with ease
  • As a User I want to be able to use the website with ease with clear messages
  • As a User I want to be able to find a wide arrange of recipes
  • As a user I want to find new and random recipes using certain ingredients
  • As a User I want to look for different international cuisines
  • As a User I want to see different recipes for certain dishes
  • As a User I want to find new and random recipes using certain dietary requirements
  • As a User I want to find new and random recipes using certain intolerance's or allergens
  • As a User I want to be able to see a image of the dish before seeing the recipe
  • As a User I want to access recipes easily
  • As a User I want to see an image of the recipe
  • As a User I want to able to use the site on different platforms

The Wireframes can be found here.

Please note. There is a big change in the wireframes compared to the end result. This happened as i didn't anticipate the difficulty in implementing the original plan.

Features

Exsisting Features

One page consisting of:

  1. landing - Hero image, Main Header and about a famous food quote
  2. Meal input field for searching either * Multiple ingredients * Specific Cuisine * Specific Dish * Meals from a certain country or region
  3. Diet input field for certain dietary requirements eg. Vegetarian or pescetarian.
  4. Allergen input field where the user can specify any allergens or intolerance's
  5. Each meal will have its title and image
  6. Clicking on the the meal card (will hover and pointer changes) will redirect the user to the recipe website on a new tab
  7. Input form will reset when user clicks on the Input
  8. Results will refresh on new submit
  9. Footer with links to Social Media
  10. Back to top feature once a search has been made so the user can return to the search form.
  11. Clear search button appear once a search has been made allowing the user to clear Results
  12. Modal appears when the user doesn't fill in the Meal input query stopping the search.
  13. Submit button which will return up to 10 results

Future Features

  • Meal planner by inputting daily calories
  • Shopping List creator based on saved recipes
  • Wine pairing and recommendations
  • User login for a search database so the user can save recipes
  • Subscription for a mailing list for new recipes based on user searches
  • Food blog
  • Random recipe upon entering the site as a recipe of the day

Technologies Used

Testing

HTML Validation ☑

html test

CSS Validation ☑

css test

JavaScript Validation ☑

An error found with $ on line 12. This is because the modal is using bootstrap.

2 variables unused, but they are linked with the html.

js test

Browser Testing ☑

Chrome FireFox Opera Edge
API
Images
Links
Render

Responsive Testing

Desktop <1200px
ipad Pro
ipad
iphone x
iphone 5/SE

User Story Testing

  • As a User I want a clean and clear Website
    • Use of colors and contrast.
    • Light main picture
    • CLear of clutter and unnescesarry items
  • As a User I want to be able to navigate around the site with ease
    • Single page site.
    • Clearly laid out.
  • As a User I want to be able to use the website with ease with clear messages
    • Easy to use.
    • Clearly labeled.
  • As a User I want to be able to find a wide arrange of recipes
    • The range of recipes to find on API are vast.
    • Each Search will return a maximum of 10 results.
    • The user can search by different countries.
    • The user can search by different & multiple ingredients.
    • The user can narrow down the search by adding dietary requirements.
    • The user can narrow down the search by adding allergens & intolerance's.
    • The user can search specific recipes.
  • As a user I want to find new and random recipes using certain ingredients
    • The user can find recipes using a single ingredient
    • The user can search by different & multiple ingredients.
  • As a User I want to look for different international cuisines
    • The user can search by different countries.
    • The user can search by different cuisines.
  • As a User I want to see different recipes for certain dishes
    • The user can search specific recipes.
  • As a User I want to find new and random recipes using certain dietary requirements
    • The user can narrow down the search by adding dietary requirements.
  • As a User I want to find new and random recipes using certain intolerance's or allergens
    • The user can narrow down the search by adding allergens & intolerance's.
  • As a User I want to be able to see a image of the dish before seeing the recipe
    • Each result has an image which is the link to the recipe.
  • As a User I want to access recipes easily
    • Each result has an image which is the link to the recipe.
  • As a User I want to see an image of the recipe
    • Each result has an image which is the link to the recipe.
  • As a User I want to able to use the site on different platforms
    • The site has been tested on different browsers.
    • The site has been tested for responsiveness.

Bugs

  • Empty input still returning default results
    • An if statement to check if the input is equal to "" would return an error modal telling the user the input field is empty.
  • Default results returning when an invalid input is sent
    • Change to the if statement on line 29. To check if the length is greater than 0.
  • No response if no recipe is found
    • Change to the if statement on line 29. To check if the length is greater than 0.
  • Site had to be refreshed for new searches
    • Clear search results button at the bottom of the results refreshes the page.
    • Old Results get replaced with new results on a new search.

Deployment

Deploying the project

  1. Go to Github
  2. Go to repository
  3. Click on settings

deploy 1

  1. Go to the pages section(Now has it's own tab)

deploy 2

  1. Under source click "none" and select "Master Branch".

deploy 3

  1. Click save
  2. Site address is here

depoy 4

Run the code Locally

  1. On Github, navigate to the main page of the repository.
  2. Above the list of files, click Code.
  3. Copy the URL on HTTPS by clicking the clipboard.

clone

  1. In your IDE of choice, open Git Bash.
  2. Change the current working directory to the location where you want the cloned directory to be made.
  3. Type git clone, and then paste the URL copied from Github.
  4. Press enter and the local clone will be created.

Credits

Media

  • The main image was sourced from Freepix

Content

Acknowledgements

whats-cooking's People

Contributors

pbaker321 avatar

Watchers

 avatar

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.