todo

Author: Andrew-Kim

README.md

@@ -1,6 +1,7 @@
 # driveshare-graph
 
-Go to [graph.driveshare.org](graph.driveshare.org) to see network statistics. Built using the Flask framework. MongoDB contains raw data on farmers. 
+Go to [graph.driveshare.org](graph.driveshare.org) to see network statistics. Built using the Flask framework. MongoDB contains raw data on farmers. Data in MongoDB is collected from the farmers and totalStorage scrapy scripts which are located in the scrapers directory. 
+
 Currently displays:
 * total storage capacity over time 
 * average capacity per farmer 
@@ -9,17 +10,16 @@ Currently displays:
 * histogram of active farmers' uptime percentages (active farmers are farmers who have been seen on the network in the past week)
 * average uptime percentage of active farmers
 
-## How to set up and deploy website
-
-### Ubuntu Digital Ocean Node
+## Setup on Ubuntu Digital Ocean Node
 
-**Setup**
+###Setup
 ```
 sudo apt-get install sqlite3 gunicorn tmux
 pip install -r requirements.txt
 ```
 
-**Setup MongoDB**
+###Setup MongoDB
+
 For instructions on how to migrate/copy the existing MongoDB, look at the README in the scrapers folder. After restoring the MongoDB on a machine, run the scrapers in order to continue collecting data on farmers. 
 ```
 tmux attach -t crawler
@@ -28,22 +28,24 @@ cd ~/driveshare-graph/scrapers
 ```
 Detach the tmux session (ctrl-b then d) after starting the scrapeAPI script. 
 
-**Deploy**
+###Deploy
 ```
 tmux attach -t driveshare-graph
 cd project
 gunicorn -b 0.0.0.0:80 --workers=4 app:app
 ```
 Detach the tmux session after running gunicorn.
 
-Then, create a new tmux session that will update the network.db every 30 seconds.
+Then, create a new tmux session that will update the network.db.
 ```
 tmux attach -t updateSQL
 cd project
 python updateSQL.py
 ```
 Detach the tmux session after beginning the updateSQL script. 
 
+
 ## Databases
 
-network.db in the project directory is a sqlite database containing duration and uptime information for each payout address. 
+network.db in the project directory is a sqlite database. The farmers table contains duration and uptime information for each payout address. updateSQL.py updates the network.db every 30 seconds. MongoDB queries take a lot of time to execute, so the farmers table is used to generate the uptime histogram and average uptime percentage. 
+

TODO

@@ -0,0 +1,4 @@
+-Code can be optimized for faster loading. 
+-Graphs should be made more interactive. 
+-Could add graphs such as height/size histogram. 
+