diff --git a/app/app.py b/app/app.py index 5ea3a9b..aea3c68 100644 --- a/app/app.py +++ b/app/app.py @@ -16,11 +16,6 @@ from api.kroger_shopping_cart import ShoppingCart from api.kroger_store_locator import KrogerStoreLocator - -# root_dir = Path(__file__).resolve().parent.parent -# sys.path.append(str(root_dir)) -# from api.shopping_cart import main - root_dir = Path(__file__).resolve().parent.parent sys.path.append(str(root_dir)) diff --git a/examples/.DS_Store b/examples/.DS_Store new file mode 100644 index 0000000..c906c88 Binary files /dev/null and b/examples/.DS_Store differ diff --git a/examples/example.md b/examples/example.md new file mode 100644 index 0000000..11a73dd --- /dev/null +++ b/examples/example.md @@ -0,0 +1,23 @@ +# For Collaborators -- How to Run/Deploy Our Project + +The following instructions are to be performed in a command line interface from the root directory of the project: +- "git clone" the repository to download the latest version of the application +- Download conda, and creating a virtual environment from the environment.yml file, located at the root of the repository. + - The command for this is conda env create -f environment.yml. +- Run "python app/app.py" + +![Home Page](images/Front-Page.png) + +The app will run on the URL: http://127.0.0.1:8050/ + +# How to Use App + +- Enter your zip code +- Select your store of interest +![Select Store](images/Select-Store.png) +- Scroll through recipes or search and press enter for a specific recipe +- Click calculate price +- Add quantities of ingredients or click the x if you don't want a certain ingredient +![Shopping Cart](images/Shopping-Cart.png) +- Click clear cart if you don't want this recipe anymore +- Make your recipe! \ No newline at end of file diff --git a/examples/images/Front-Page.png b/examples/images/Front-Page.png new file mode 100644 index 0000000..1baa6dd Binary files /dev/null and b/examples/images/Front-Page.png differ diff --git a/examples/images/Select-Store.png b/examples/images/Select-Store.png new file mode 100644 index 0000000..66c2e54 Binary files /dev/null and b/examples/images/Select-Store.png differ diff --git a/examples/images/Shopping-Cart.png b/examples/images/Shopping-Cart.png new file mode 100644 index 0000000..471967a Binary files /dev/null and b/examples/images/Shopping-Cart.png differ