Flask Web Application template

Documentation Status CircleCI

This is a template for a basic Flask web application that responds an HTML page on localhost:8080.

This template comes with support for:

Don’t hesitate to contribute!


Create a virtual environment and install the requirements.

make venv/bin/activate

Init the database by creating all tables.

export DATABASE_URL=sqlite:///../db.sqlite3
export FLASK_APP="application.app"
flask init-db


Run the application debug mode.

FLASK_DEBUG=True flask run

If you wish to use Docker for deploying the app, run the following:

docker-compose up -d


Automatically create and build the code documentation using Sphinx. You can use Read the Docs to build and host the documentation, like I did here.

make docs

Indices and tables