Watchdog is a stock simulation application that is meant to be very basic.
Its end goal is to offer basic buy/sell features, limited information on stocks, and a competitive leaderboard.
virtualenv
Python 2.7
Django 1.10
See the requirements.txt file for what is installed in the virtualenv. Use the script ./update.sh to download the dependencies after you activate the virtual environment(see Setup).
Clone the repository. Then, cd into the parent directory. To enter the virtual environment, run source ase/bin/activate
and make sure you run ./manage.py migrate to configure your initial DB.
Next, run ./manage.py runserver to start the application.
Refer to the exceptionally detailed Django documentation for most questions.
We will be following PEP8 standards. We will use flake8 and pylint to lint and statically analzye our application.
###Testing & Continuous Integration
To locally run our tests, we use ./manage.py test. If you want to run tests with coverage, running our custom script ./test_coverage will run tests, generate a coverage directory(gitignored) and open index.html, which displays a comprehensive code report.