|
|
|
|
cookiecutter-flask
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
A Flask template for cookiecutter_.
|
|
|
|
|
|
|
|
|
|
.. _cookiecutter: https://github.com/audreyr/cookiecutter
|
|
|
|
|
|
|
|
|
|
Features
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
- Twitter Bootstrap 3 and starter templates
|
|
|
|
|
- Flask-SQLAlchemy with basic User model
|
|
|
|
|
- Flask-WTForms with login and registration forms
|
|
|
|
|
- Procfile for deploying to a PaaS (e.g. Heroku)
|
|
|
|
|
- nose for testing
|
|
|
|
|
- A simple ``manage.py`` script.
|
|
|
|
|
- CSS and JS minification using Flask-Assets
|
|
|
|
|
- Easily switch between development and production environments through the MYFLASKAPP_ENV system variable.
|
|
|
|
|
|
|
|
|
|
Screenshots
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
.. image:: https://dl.dropboxusercontent.com/u/1693233/github/cookiecutter-flask-01.png
|
|
|
|
|
:target: https://dl.dropboxusercontent.com/u/1693233/github/cookiecutter-flask-01.png
|
|
|
|
|
:alt: Home page
|
|
|
|
|
|
|
|
|
|
.. image:: https://dl.dropboxusercontent.com/u/1693233/github/cookiecutter-flask-02.png.png
|
|
|
|
|
:target: https://dl.dropboxusercontent.com/u/1693233/github/cookiecutter-flask-02.png.png
|
|
|
|
|
:alt: Registration form
|
|
|
|
|
|
|
|
|
|
Using this template
|
|
|
|
|
-------------------
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
$ pip install cookiecutter
|
|
|
|
|
$ cookiecutter https://github.com/sloria/cookiecutter-flask.git
|
|
|
|
|
|
|
|
|
|
You will be asked about your basic info (name, project name, etc.). This info will be used in your new project.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Inspiration
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
- `Building Websites in Python with Flask <http://maximebf.com/blog/2012/10/building-websites-in-python-with-flask/>`_
|
|
|
|
|
- `Structuring Flask Apps <http://charlesleifer.com/blog/structuring-flask-apps-a-how-to-for-those-coming-from-django/>`_
|
|
|
|
|
- `Flask-Foundation <https://github.com/JackStouffer/Flask-Foundation>`_
|
|
|
|
|
- `flask-basic-registration <https://github.com/mjhea0/flask-basic-registration>`_
|
|
|
|
|
- `Flask Official Documentation <http://flask.pocoo.org/docs/>`_
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
BSD licensed.
|
|
|
|
|
|
