Git Product home page Git Product logo

get-the-recipe-resubmit's Introduction

Get the Recipe

Get the Recipe is a website aimed at providing easy access to thousands of recipes to suit every users needs. I will also use this site as a space to keep my favouite recipes and provide inspiration for users. The website will take a user centric approach with a clear and easily navigated design.

UX

The Strategy Plane

This website aims to;

  • provide recipes for users looking to bake or cook someting specific with the use of the search function
  • inspire users by hosting some recipes on the site
  • increase social media presence

The Scope Plane

Users will be able to achieve the above goals through the use of the following;

  • The edamam API function which allows us to search thousands of recipes as well as giving nutritional value and details on each.
  • The recipes page will feature a range of different recipes to inspire users.
  • The contact form will allow users to get in contact with me regarding any questions/ feedback they have.
  • The social media links at the bottom of the page allow users to contact us on Facebook, Twitter, Instagram and Pinterest.

The Structure Plane

The website will consist of three pages, a home page, recipes page and contact page. The navigation bar at the top of the page will allow the user to switch between the pages. The social media links at the bottom of each page will take the user directly to the respective media pages. The contact form allows the user to send messages directly to myself.

The Skeletal Plane

mobile-wireframe desktop-wireframe

The Surface Place

The website will host a range of images of food to tempt uses and encourage them to bake. The recipes will display an image with a brief description of the recipe including ingredients used and calories and there will be a 'see recipe' button below when if clicked will take the user directly to the recipe. The background will be a light blue colour as it is a colour which represents peace and calm. I find this suits the thereputic act of baking very well. I will use cursive text as it gives a more personal feel to the page. The text colour will be grey in contrast to the light coloured background. When a search is carried out, the recipies will appear with an image and brief description. The full recipe will not be displayed until the user clicks 'see recipe' at which point the recipe will open in a new tab. This is to ensure there is no clutter on the page.

Features

Existing Features

  • Navbar - allows users to easily naviagte between the three pages, Home, Recipes and Contact.
  • Search function - allows users to find recipes specific to their needs or they can even find recipes by searching the ingredients they have available. Examples of searches "low-fat muffins", "gluten-free brownies", "apples, flour, sugar".
  • Contact form - allows users to submit comments, questions directly to my mailbox by filling in the contact form.
  • Recipe preview - users can view pictures of the recipes and have the option of viewing the whole recipe when the click the 'see recipe' button.

Features Left to Implement

In future I would like to include:

  • a profile section where users can save there favourite recipes and basically create their very own online cookbook.
  • a healthy eating section where users can learn more about different foods and their benefits.

Technologies Used

I used the following technologies in this project:

  • GitHub
    • The project uses GitHub for version control.
  • GitPod
    • The project uses Gitpod for the working environment.
  • HTML
    • The project is written using HTML.
  • CSS
    • CSS is used to style the project.
  • Bootstrap 3
    • The Bootstrap 3 library is used to assist with CSS styling.
  • Javascript
    • The project uses Javascript to implement the Edamam API.
  • JQuery
    • The project uses JQuery to simplify DOM manipulation.
  • Edamam API
    • The project uses the Edamam recipe search API to access the thousands of recipes they have available.
  • Chrome Develper Tools
    • I used Chrome Developer Tools to help identify problems in the code.

Testing

  1. Navbar:

    1. Go to 'home" page
    2. Try to access "recipe" page via home page.
    3. Go back to "home" page and try access "contact" page
    4. Go to "recipe" page.
    5. Try to access "home" page from "recipe" page
    6. Return to "recipe" page and try to access "contact" page
    7. Go to "contact" page
    8. Try to access "home" page from "contact" page
    9. Return to "contact" page and try to access "recipe" page
  2. Recipe search:

    1. Go to "recipe" page
    2. Try to search for a recipe and verify that it works
    3. Try to search for another recipe and verify that a new search has completed
  3. Social media links:

    1. Go to facebook icon on 'home' page, click and ensure facebook opens in new tab
    2. Go to instagram icon on 'home' page, click and ensure instagram opens in new tab
    3. Go to twitter icon on 'home' page, click and ensure twitter opens in new tab
    4. Go to pinterest icon on 'home' page, click and ensure pinterest opens in new tab
    5. Go to facebook icon on 'recipe' page, click and ensure facebook opens in new tab
    6. Go to instagram icon on 'recipe' page, click and ensure instagram opens in new tab
    7. Go to twitter icon on 'recipe' page, click and ensure twitter opens in new tab
    8. Go to pinterest icon on 'recipe' page, click and ensure pinterest opens in new tab
    9. Go to facebook icon on 'contact' page, click and ensure facebook opens in new tab
    10. Go to instagram icon on 'contact' page, click and ensure instagram opens in new tab
    11. Go to twitter icon on 'contact' page, click and ensure twitter opens in new tab
    12. Go to pinterest icon on 'contact' page, click and ensure pinterest opens in new tab
  4. HTML validation

I ran the html pages through a html5 validator.

Index.html HTML-validation Recipe.html HTML-validation Contact.html HTML-validation

  1. CSS Validation I ran the the CSS stylesheet through the CSS validator. CSS-validation

  2. Javascript Validation I ran recipe.js through JSHint. Javascript-validation

Deployment

  • I started creating this website in a local git. I used 'git init' to create a new repository.
  • At various stages I used 'git add .' to add changes to the repository.
  • I used 'git commit -m "..."' to commit these changes with a message identifying what has been changed.
  • I used 'git push' to push up the local git repository.
  • The GitHub repository was made live via GitHub pages
  • The website can be found at https://evanneb.github.io/get-the-recipe/.

Credits

Content

The recipes featured on the home page are from the following websites:

Media

The photos used in this site were obtained from ...

  • The Chocolate Cake image is from Unsplash
  • The Cupcakes image is from Unsplash
  • The Lemon Drizzle Cake image is from Unsplash
  • The Carrot Cake image is from Unsplash

Acknowledgements

get-the-recipe-resubmit's People

Contributors

evanneb avatar

Watchers

 avatar  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.