Home

Welcome to the flask-boilerplate wiki!

This is an minimal but opinionated boilerplate meant for building out simple REST APIs deployed with Heroku primarily used at Hack4Impact UIUC. This app is written in Python 3.6 with Postgres 10 as the chosen data persistance. You can deploy it with another service, like AWS, Google Cloud, or DigitalOcean with Gunicorn and Nginx, but instructions for that are not provided. Included are simple examples and instructions developing with or without Docker are provided. I've also written a blog post about using Docker based on this repository.

Some tools we use:

• black for code formatting
• mypy for optional static typing

Getting Started

First, you must setup install and setup Python3 and Postgres. Here are the installation docs. Once you are done, look into the structure of the boilerplate and the conventions and simple examples on interacting with the database with SQLAlchemy. There's also a list of some common bugs/problems I've ran into! All of the topics are to your right!

One great way to start after everything is set up is to read the Understanding this boilerplate. It will go through what executes and a little bit of the design choices I made when coming up with this boilerplate.

Resources

• Flask Docs
• Patterns from Flask (I pull a lot from this)
• Flask-SQLAlchemy
• Different ways to use SQLAlchemy in Flask (we use Flask-Alchemy)
• Flask Application Contexts