flask_structure_example

This repository contains the source code to accompany "Structuring Large Flask Applications".
For a more in-depth explanation please refer to the post.

An example of how to structure a medium to large sized Flask application, with boilerplate for common setup and configuration.

Quickstart

To run the example application, first clone the repository to your working directory. From there, activate the virtual environment and install the dependencies before running the application.

$ # Clone the respository, and change to it
$ git clone https://github.com/jessebraham/flask_structure_example.git && cd $_
$ # Activate the virtual environment and install all dependencies
$ pipenv shell
$ pipenv install
$ # Source the .env file, or export the variables within it
$ source .env
$ # Run the Flask application
$ flask run

Requirements

This project was developed using Python 3.6.5 (however any version of Python 3 should work) and Pipenv. The only required packages are Flask and Flask-SQLAlchemy.