Giter VIP home page Giter VIP logo

meals-around-the-world's Introduction

Meals Around the World

Welcome to Meals Around the World. Meals Around the World is a single-page JavaScript web application that uses TheMealDB to fetch meal recipes from its API. TheMealDB API is an open database focusing on recipes from around the world. This web app is intended for people to access the list of meals from different countries. The users can click on a meal to see the list of meals that displays the name of the meal, its image, what category it is, where it came from, how to make it, its measurements, and more. Furthermore, the web app allows users to type on a search tab to search for a specific meal list. There is a form for a user to input to add a meal with information that is added to the list of meals.

Project Developers:


Demo

Alt text

Installation

1. Fork this repository

Alt text

2. In terminal, choose or create a folder you want to work in

mkdir FOLDERNAME

3. Clone from SSH into your local environment

Alt text

git clone [email protected]:isaacsong1/Meals-Around-the-World.git

4. Start local JSON Server. Inside terminal, run

json-server --watch db.json

5. In the terminal, open the file to check in the browser

Mac:

open index.html

Windows:

explorer.exe index.html

Usage

Analyze recipe information

  • Meal name, category, and country of origin
  • Picture of the dish
  • Ingredient and measurement list
  • Instructions on how to prepare the dish

Interact with navigation bar on the left

  • View selected meal on the main page by clicking on meal name

Search desired meals

  • Enter the name of the dish in the search bar then press 'enter'
  • Navigation bar on the left should be updated with names including search parameter
  • Click on meal name in navigation bar to display information on the main page

Add your own meal and display it on the main page once submitted

  • Click on 'Open to Add Meal' button
  • Enter new meal's information per instructions below
    • Meal's Name (Ex: Chicken Nuggets)
    • Category (Ex: Chicken)
    • Country of Origin (Ex: American)
    • Image URL
    • Measurements and Ingredients items separated by commas (Ex: 3, Chicken Breasts, 1 cup, Bread Crumbs, 1 tbsp, Dried Basil, ...)
    • Directions
  • Press 'Submit' button and meal will display on the main page and meal's name will be appended to navigation bar
  • Form is cleared, press 'X' to close modal

Display a random meal

  • Can't figure out what to eat? We have that covered.
  • Press the 'Random Meal' button and a meal will appear on the main page with all the information

References

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change and we will review them as soon as we can.

Please make sure to update tests as appropriate.

License

MIT License

meals-around-the-world's People

Contributors

hanna-n9 avatar isaacsong1 avatar isaacwilhite avatar

Stargazers

Kat Tannehill 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.