/line-picker-webapp

Primary LanguagePython

Line Picker

https://apt-line-picker.appspot.com/
APT-Team-6
Team members: Robin Franklin, Nathan Wiatrek, Ben Musil, and Sanjai Pillai

Table of Contents

Program Overview
Phase 1
Phase 2
Quirks

Program Overview

Line Checker uses crowdsourcing data to find out wait times of nearby restaurants based on category of food, distance to user, favorite category set by user, and other similar criteria. Users can submit wait times for specific restaurants with a picture to show the activity of the restaurant. Users also have the ability to add restaurants and check previous post history.

Data is hosted with MangoDB and Flask is used as the web framework to interact between the user and the database.

Phase 1

APIs IMPLEMENTED

  1. Create user and post to database
  2. Get user from database based on username
  3. Delete user from database based on username
  4. Get all restaurants from database and list them
  5. Get all restaurants from database by tag and list them
  6. Get wait time by a specific restaurant from database and list them

HOW TO RUN FOR PHASE 1

  1. Run the Flask framework by running the app.py script first
  2. Test API methods by running tests/test_app.py next

RUNNING UNIT TESTS

  1. In pycharm go to the unit test file (these are located in /tests) and run the main method
  2. If you are not in pycharm, simply run python tests/test_restaurant.py to run the unit tests for that file

Phase 2

Web APIs and How to Access Them

  1. Management
    After logging in using Google's authentication service, the user can change their favorite restaurant under the user settings page. This will change what restaurants the user sees automatically populated on their home page. Users can also view all their reports under "My Submissions" on the sidebar.

  2. Create a Theme
    Users can create a restaurant by going to "Add a Restaurant" on the sidebar and submitting the requested information.

  3. View a Theme
    Users can see restaurant details by clicking on the name of the restaurant that is in the search results field in the "Search Restaurant" section of the site.

  4. Submit Report
    Users can submit wait times and images by going to a restaurant page (explained by the View a Theme API) and submitting the requested information.

  5. View All Themes
    Users can view see all restaurants at once by clicking the "All" category under "Food Type" in the search page. The search returns title, address, wait time, last reported by, and latest posted image.

  6. Search Reports
    Search for a specific restaurant or category by using the search bar on the search page. The searched word will match with tags from either a restaurant name or a category and return matches to the results table.

Quirks

  1. Google Auth
    After the token expires the applicaiton will send the user back to the login page, from there the only option is to sign out. simply sign out and then sign back in and everything will go back to normal.