fgimian / flaskage

Flaskage is a complete and carefully designed template for use with the Flask web framework.

Flaskage

Please note that this project is a work in progress

Artwork courtesy of Open Clip Art Library

Introduction

The Flaskage template attempts to bring together all the best packages and integrate them with Flask so you have a full stack MVC (or MTV) structure ready-to-use.

Flaskage takes a lot of inspiration from frameworks like Ruby on Rails, Play and Laravel and doesn’t attempt to re-create the Django way of working.

Quick Start

Install Flaskage in your virtualenv as follows:

pip install git+git://github.com/fgimian/flaskage.git

Create a new project:

flaskage new <project-name>

Start the development server and check out your new project:

cd <project-name>
./manage.py server

Refer to the documentation for further instruction.

Documentation

Please check out the Flaskage documentation at Read the Docs.

License

Flaskage is released under the MIT license. Please see the LICENSE file for more details.

TODO

CLI

• Complete unit tests for the flaskage CLI tool
• Consider a scaffolding command for BDD and Jade templates

Project Structure

• Determine the best way to deal with symbolic link for Twitter Bootstrap fonts

Documentation

• Complete writing documentation

Long-term goals are as follows

• Generation of scaffolding including CRUD
• Pluggable scaffolding modules
• Ability to generate foreign keys and relationships via scaffolding
• Consider supporting a Django-like directory layout