Git Product home page Git Product logo

groceryhelper's Introduction

Grocery Helper

Maggie Rosner, Elena Meyerson, Kyle Combes, and Nina Tchirkova

Grocery Helper assists you in planning your grocery shopping. Given a list of items and a location, it will tell you which stores nearby carry the items and what the best itinerary is to go about purchasing them.

Project Website

More details on this project can be found here.

Setup Instructions

Dependencies

In order to run GroceryHelper on your own computer, you'll need the following Python 3 modules installed:

  • flask
  • untangle
  • requests

API Keys

Then you'll need to create a file called keys.py in your project root and put the necessary API keys in it. For the sake of saving the SoftDes grading team the trouble of manually getting all of the keys, you can simply copy the contents of this Google Doc and paste it into keys.py. (Note: The Doc will be made private again after June 1, 2017.)

Setting Up the Database

In preparation for running the web app, you'll need to create the stores and items database and download the nearby stores data. To do that, just run python3 setup.py. It will download and install all the necessary data.

By default it will just download stores in Massachusetts. If you want to add a different ZIP range, simply run python3 update_db.py, using the optional arguments--start-zip and --end-zip to specify the range of ZIP codes to pull stores for. Using the argument --workers will set the number of simultaneous requests to make while doing so. Running the script without any arguments is the same as running python3 update_db.py --start-zip 2000 --end-zip 3000 --workers 100.

Launching the Web App

To actually launch the web app, simply run python3 webapp_flask.py. Then visit http://127.0.0.1:5000/ in your web browser. Click the "Get Started" tab to a

Architecture Review

The Architecture Review Preparation and Framing document can be found here.

Architecture Review Reflection and Synthesis

Notes and reflection from the Architecure Review can be found here.

Link to Poster

poster

groceryhelper's People

Contributors

kylecombes avatar margaretrosner avatar ntchirkova avatar elenameyerson avatar

Watchers

James Cloos 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.