Crypto Counter

Python version 3.6.x

Django version 2.0.x

Installation:

1. Use link below to configure Python3 and pip (package manager) on your machine. Your choice to use the Python in the main environment or setup a virtual environment (VE recommended).
   NOTE: All the commands with python and pip below have them set to default to python3 and pip3 if these are not the defaults on your machine you will need to use pip3 instead of pip or python3 instead of python in the terminal commands listed below. https://developer.mozilla.org/en-US/docs/Learn/Server-side/Django/development_environment
2. Clone the GitHub repo from https://github.com/trlee2/CryptoCounter
3. Install PostgreSQL on your machine

• On Windows: https://www.postgresql.org/download/
• On Mac:

$ brew update
$ brew doctor
$ brew install postgresql
$ brew services start postgres

• On Linux:

$ sudo apt-get install postgresql

4. Setup local instance of database and create user. We used ccadmin as the database owner and we set the password for ccadmin to '1', this needs to be done within PostgreSQL and in the directory that contains the manage.py file. This reflects the setup in the settings.py file. If this isn't set up properly the django app will not be able to run at all. (It is very important to have the user set up and have all permissions granted to that user in the database. Also having the user password in postgresql match the password in the settings.py file is necessary to get the django app to run). When you create a database in PostgreSQL it is not located in the current directory, and will need to be modified within the postgre terminal to get it configured properly. Setting up the database gave us a lot of issues early on so make sure the directions are followed carefully.

$ createdb cryptoDB
$ psql cryptoDB

or

$ psql postgres
postgres=# CREATE DATABASE cryptoDB;
postgres=# \q
$ psql cryptoDB

then

cryptoDB=# CREATE USER ccadmin WITH PASSWORD '1';
cryptoDB=# GRANT ALL ON DATABASE "cryptoDB" TO ccadmin;
cryptoDB=# \q

5. Install Django, version 2.0.x

$ pip install Django

6. Install PostgreSQL Python adapter

$ pip install psycopg2

5a. Install other libraries for the background tasks to run (in main directory)

$ pip install requests
$ pip install apscheduler
$ pip install TwitterAPI
$ pip install pytrends
$ pip install praw
$ pip install tweepy

7. Build the tables using the command (in project directory where manage.py resides):

$ python manage.py migrate

8. Start built-in Python Server and run cron (run cron with -p and a low number otherwise it will take a long time to scrape all the data; this will result in fewer data points in the graphs but you won't have to have cron running for 24+ hours first before you can run the server)

$ python manage.py runserver
$ python cron.py

9. Cron can also take arguments when ran

$ python cron.py -h
----------------------------------------------------------------------------
long argument   short argument  definition
----------------------------------------------------------------------------
--help             -h             Show this help message and exit
--cron             -c             Enable cron mode
--reset            -r             Truncate all tables that cron interacts with
--test             -t             Start xUnit tests
--history [days]   -p             Sets the number of days to go back in history
                                    Default: 184 days (6 months)
--debug            -d             Debug mode of testing as we code                                    
-----------------------------------------------------------------------------

10. When running cron for the first time, it may take over an hour or more to load in data. If it looks like the program is hanging, do not worry, this is just cron handling data. Twitter is also disabled for overall social and ICO social data on the backend, due to the time it takes to record the info. Instead it is recorded as a -1.

10a. The default for cron is 184 days of historical prices. To speed up cron, set historical days to a smaller number like 3 for an example.

$ python cron.py -p 3

11. Bugs can be found in GitHub's issue tracker at https://github.com/trlee2/CryptoCounter/issues
12. Live site can be found at https://cccounter.herokuapp.com