Skip to content

foodive/be-foodive-python

Repository files navigation

Foodive

Screen Shot 2022-09-06 at 8 54 44 PM

Table of Contents
  1. About the Project
    • Built With
  2. Getting Started
    • Prerequisites
    • Installation
  3. EndPoints
    • Partner Repository
    • Contributors
  4. Thank you

About the Project

Take the thinking out of picking a restaurant and use Foodive! Foodive is an application that allows you to click one button and it will randomly select a restaurant in your area. When the restaurant is selected, business details are provided such as rating, price and food category! Want a specific restaurant? Use the filters feature, where if you want a specific genre of food like mexican, click the button "mexican" and your one click away from getting a random mexican restaurant. This is a backend application which has a partner repo called fe-foodive(https://github.com/foodive/fe-foodive.git)

Built With

  • Python
  • Django
  • Heroku
  • CircleCi
  • Figma
  • Atom
  • VSCode
  • Github
  • Love

Getting Started

Prerequisites

  • Python
  • Django

Installation

  1. Get your API key from these websites
  1. Clone the repo git@github.com:foodive/be-foodive-python.git

  2. Move into the file cd be-foodive-python

  3. Setup virtual environment python3 -m venv .venv

  4. Activate virtual environment . venv/bin/activate

  5. Install django packages pip install -r requirements.txt

  6. Create .env file in the root directory of the project and insert YELP_API_KEY=YOUR API KEY

  7. Delete .circleci folder

  8. Please clone foodive-fe repoistory to ensure full functionalilty of the application

  9. Happy Hunting!

End Points

Retrieve a random restaurant

GET /restaurants/?location=denver&categories=mexican
{
"data": {
    "id": "null",
    "type": "restaurant_info",
    "attributes": {
        "name": "El Camino Community Tavern",
        "image_url": "https://s3-media4.fl.yelpcdn.com/bphoto/on-W4Ctj96UOMeM5phdphA/o.jpg",
        "categories": [
            "Mexican",
            "Bars",
            "Breakfast & Brunch"
            ],
        "rating": 4,
        "coordinates": {
            "latitude": 39.762136,
            "longitude": -105.03544
        },
        "price": "$$",
        "display_address": [
            "3628 W 32nd Ave",
            "Denver, CO 80211"
        ],
        "display_phone": "(720) 889-7946"
        }
    }
}

Partner Repository

Contributions

BackEnd Team

📶 Luke Swenson: Github: https://github.com/LukeSwenson06 Linkedin: https://www.linkedin.com/in/luke-swenson

🥟 Becky Nisttahuz: Github: https://github.com/benistta Linkedin: https://www.linkedin.com/in/becky-nisttahuz/

🪴 Jim Riddle: Github: https://github.com/jimriddle1 Linkedin: https://www.linkedin.com/in/jim-riddle-b6718037/

FrontEnd Team

🍲 Lourdes Benites: Github: https://github.com/lourdesbnts Linkedin: https://www.linkedin.com/in/lourdesbenites/

🔖 Kristy Nguyen: Github: https://github.com/kpn678 Linkedin: https://www.linkedin.com/in/kristypnguyen/

🌃 Dylan Duke: Github: https://github.com/laytonmaes Linkedin: https://www.linkedin.com/in/dylan-duke-005756129/

🎨 Grant X Beard: Github: https://github.com/GrantXBeard Linkedin: https://www.linkedin.com/in/grant-x-beard/

Thank You

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published