• You will need to have Python 3 installed on your machine or have access to a Python 3 interpreter. See Python's site for details.

• Copy this repo to your computer; the below assumes you have kept the default folder name as urly-bird.

• You will need to make sure that you have a virtual environment running Python 3 in the folder that you made in the above step. See this site for details if you're not familiar. Complete this step before attempting the below.

• Using your favorite command line program (e.g., Terminal on Mac OS X), install the requirements file in your virtual environment: pip install -r requirements.txt.

• To create some fake data, you will need to run some shell commands. Navigate to the urly-bird/urlybird folder and confirm that you see the manage.py file. Then run the following lines in order. (Note that creating the clickstodb takes ~40 minutes on a 2015 MacBookPro.)

$ python manage.py migrate
$ python manage.py userstodb
$ python manage.py wormstodb
$ python manage.py clickstodb
$ python manage.py updatenumclicks

• Running the site requires more command line. Navigate to urly-bird/urlybird and enter python manage.py runserver This will take over the current command-line program's window until you stop the server. Kill the process by pressing Ctrl+C or quitting the command-line program entirely.

Located at localhost/, where localhost is the location of your Django server. Shows all worms on the site, arranged by creation/modification date.

Located at localhost/pop30, where localhost is the location of your Django server. Shows all worms created/modified on the site within the last 30 days, arranged by number of clicks.

Located at localhost/popall, where localhost is the location of your Django server. Shows all worms on the site, arranged by number of clicks.

Users on this site are referred to as "birds." Located at localhost/birds/bird_id, where localhost is the location of your django server and bird_id is the user_id. These are more easily accessed through the interface by logging in (to see your own bird page) or by clicking on another bird's name.

Logged in birds can see:

• All of their worms, arranged by creation/modified date.

• The popularity of the worms created/modified within the last 30 days.

Located at localhost/worms/worm_id, where localhost is the location of your Django server and worm_id is the number associated with that worm. These are more easily accessed through the interface by clicking on the info buttons throughout the site.

This project was forked from a group project created by Tyler Kotkin and Adam Hartz.