Open Source Flash Cards
Before you get started, make sure you have postgresql, python3, and pip3 installed on your development machine.
Create virtualenv and install dependencies.
virtualenv -p python3 venv source venv/bin/activate pip install -r test-requirements.txt pip install -e .
Create a new production and test database.
createuser -s flashy createdb flashy createdb flashy_test
Export some environment variables. These are only necessary if you wish to test out some specific components such as email.
cp .env.example .env
Then edit the .env file and fill out the appropirate fields.
Start up local development server.
Visit localhost:5000 to see the running app.
This project aims to follow test driven development methodology and strives for as much coverage as possible.
You can run unit and integration tests with:
You can generate a coverage report with:
Then you can open up
htmlcov/index.html in a browser to see your coverage report.
Please create an issue with a description of your problem, or open a pull request with a fix.