If you haven't already (why not!?), install Pipenv. ✨🍰✨

Clone the repo and cd to the root folder. Run

$ pipenv sync

then activate the environment with

$ pipenv shell

Tell Flask where the app is located:

$ export FLASK_APP=app.py

Now you might want to create the database and populate it with some mock data:

$ flask initdb
$ flask populatetestdb

Create a user with admin privileges with which you can log in:

$ flask createadmin

Run the development server with helpful debug pages when exceptions occur:

$ FLASK_DEBUG=1 flask run

The server is now live on http://localhost:5000.

If you haven't already created /instance/config.py, one is generated for you with some sane defaults. The config in /instance overrides the default config and is not checked in to git. The generated config sets the database file to be created in /instance.

Pytest is used for testing, tests are located in tests/. Run the tests with

$ pytest tests/flasquelistan_tests.py