Skip to content

chandur626/SmartShopperProductCheck

Repository files navigation

License: MIT Build Status Build Status - GitHub Github DOI Coverage Status

SmartShopperProductCheck

SmartShopper.Intro.Video.COMP.mp4

Introduction to SmartShopperProductCheck

Have you ever bought a product only to find out your friend bought the same product at a cheaper price?

Searching for deals can be time-consuming which is why we created SmartShopperProductCheck, a webapp designed to help users find the cheapest price of their desired product. All users need to do is search for their desired product in the search bar and the webapp outputs the product pricing at various bigbox retailers such as Walmart, Target, and Costco. Our current iteration requests users to upload a .csv file of retailer links to webscrape from and input keywords, via a search bar, to grab relevant information of the desired product. Product information is then displayed back to the user. This document aims to help future developers understand the current foundation of the project and give guidance on how to setup the project locally to improe the webapp further.

Our developments in SmartShopperProductCheck were achieved using the following technologies: Python3, Django, HTML, and CSS. Any developers who wish to improve SmartShopperProductCheck should have these technologies installed before proceeding.

What SmartShopperProductCheck is doing under the hood

SSPC ITERATION1

A User looking for a product makes a search via a search bar on the user interface. SmartShopperProductCheck extracts certain keywords from the search. Using an existing .csv file with links to bigbox retailers like Target and Walmart, the program establishes a connection to these retailer links. The program then webscrapes from the links to find the product's general information (name, description, and price) matching that of the keywords extracted from the user search. Products are then outputted to the user interface for the user to view which retailers provide the cheapest price.

QuickStart


Clone the repository.

git clone https://github.com/chandur626/SmartShopperProductCheck.git


Create a virtual environment by referring to the following link.

https://www.geeksforgeeks.org/creating-python-virtual-environment-windows-linux/


Install the required packages.

pip install -r requirements.txt


Run the migrations and start the server by running the following commands.

cd ProductCheck
python manage.py migrate
python manage.py runserver


You could see the server running at http://127.0.0.1:8000/ .


To ensure everything is working expected, execute the tests by using the following command.

python manage.py test


Start the cron job by using the following command.

python manage.py crontab add


To stop the cron job, run the following command.

python manage.py crontab remove


To stop the cron job, run the following command.

python manage.py crontab remove


Run the following command to make sure that the cron jobs are initiated.

crontab -l

Goals for the future

  • Create Account functionality to save user data and provide more personalized features

  • Have SmartShopperProductCheck have a degree of intelligence and make product recommendations

  • Maybe the best price isn't at a bigbox retailer. Create a wider search across a diverse list of stores to find the cheapest price.

  • Checkout project board https://github.com/chandur626/SmartShopperProductCheck/projects/1 for other enhancements.

Team Members

Chandrahas Reddy Mandapati

Sri Pallavi Damuluri

Niraj Lavani

Harini Bharata

Sandesh Aladhalli Shivarudre Gowda