From 68221f113ba8435fe616146ab529a7a251e19687 Mon Sep 17 00:00:00 2001 From: rav4s Date: Sat, 6 Feb 2021 16:33:40 -0600 Subject: [PATCH] Added readme file --- readme.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..e211733 --- /dev/null +++ b/readme.md @@ -0,0 +1,15 @@ +# iFixit-Repairability-Dashboard + +Pulls repairability scores for various devices from iFixit, which are then displayed on a website in a few categories. + +## What does each file do? + +The scraper.py file scrapes iFixit's webpages at https://www.ifixit.com/smartphone-repairability, https://www.ifixit.com/laptop-repairability, and https://www.ifixit.com/tablet-repairability. It then takes the html and parses it to find three fields for each device: Manufacturer, Device Model, and Repairability Score. The data for these three fields is then written to one of three csv files (laptop.csv, smartphone.csv, and tablet.csv) based on the device type. + +Once these files are stored, you can run Web_Dashboard/app.py, which starts a waitress server that serves webpages for each repairability score. The webpage templates are located in the Web_Dashboard/templates directory and the stylesheets are located in the Web_Dashboard/static directory. The webserver will be accessible at 0.0.0.0:1235. + +## Live Demo + +A live demo of this project is available at repairability.yeetpc.com + +Note: this project is neither sponsored by nor affiliated with iFixit.