Flask Web Application template

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

This template comes with support for:

• SQLlite database
• Sphinx documentation
• Twitter Bootstrap
• Font Awesome
• Docker and docker-compose

Don't hesitate to contribute!

Install

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

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

Docs

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

Clone the template to another directory

./install.sh /path/to/your/dir