Flask Boilerplate Project

Introduction

I wanted a super-quick way to create new websites with all my favorite code settings and customizations. Hence, I created this boilerplate project based on the Flask (Python) microwebframework.

Why Flask-Boilerplate? Because you get:

1. Good code defaults – for example, (1) it uses packages and modules by default so that controllers and models are organized into a standard directory structure and split into multiple files, (2) it merges and compresses your various CSS files into one, your multiple JS files into one, for performance reasons. And so on.
2. New Project script – sets up everything for you right from generating the secret key (for secure cookies) to integrating memcache (including mimicing Rails.cache.fetch with helpers).
3. Deploy to a Ubuntu server with a single command – sets up everything for you, including virtualenv, etc.
   • NOTE: The installation script works specifically for Ubuntu Linux, Apache, mod_wsgi only.
4. jQuery – no webapp is complete without it.
5. Grid system, via the 960 Grid System – so that you can get started with your UI quickly.
6. HTML5 goodness, via HTML5 Boilerplate – for a good base UI.

Get Started

git clone git://github.com/swaroopch/flask-boilerplate.git mynewapp
cd mynewapp
pip install Fabric
fab code_init:mynewapp.com
fab env_setup
Write your code in flask_application/controllers/frontend.py
fab server

When you’re ready to deploy your code to a server:

fab server_setup # once per server
fab deploy

When you clone a repo and want to run it:

fab env_setup
fab server

Also See

• Mobile browser detection to redirect users to a version of the website that uses the Mobile HTML5 Boilerplate.
• API wrapper like simpleapi.