flashy.cards

All of these commands should be run from this directory (the one containing README.md)

Setup

Flashy requires Python 2. Install this, and pip.

Flashy also requires a running Redis server.

Virtualenv for Windows creates a dir inexplicably named scripts rather than bin. So substitute venv/bin for venv/scripts if you are on Windows.

Install virtualenv before continuing. This is most easily accomplished with:

pip install virtualenv

Set up the environment by running:

scripts/setup.sh

Run tests:

scripts/run_tests.sh

Migrate/create the local (SQLite) database:

python manage.py migrate

Run development server (local):

scripts/run_local.sh

This requires that flashy-backend be in the directory as flashy-frontend.

Import sections from JSON:

python manage.py loaddata sections

Troubleshooting

If you get errors about a module not being found, make sure you are working in the virtualenv. To enter the venv:

. venv/bin/activate

If you still get errors about a module not being found, make sure your virtualenv is up to date. Re-run:

scripts/setup.sh

If you get errors about a missing column or table, make sure you have migrated:

python manage.py migrate