This is a CookieCutter template for generating a bare bones Flask project based off of fbone within a Vagrant development environment. It provides simple starting points for using some of the popular best-practices and features:
- Proper setuptools compatible package layout.
- Several of nearly-standard extensions (Flask-SQLAlchemy, Flask-WTF, Flask-Cache, Flask-Script)
- Flask-Testing and Twill based tests.
- Vagrant development environment to provision Nginx and uWSGI properly and seamlessly.
- Bower for frontend package management
- Cookiecutter
- Virtualbox
- Vagrant
Before you can use this template you should install cookiecutter via easy_install or pip:
$ pip install cookiecutter
The cookiecutter executable should appear in your Python's bin/ (in Windows Scripts/) directory. You might need to add that directory to your PATH to run the executable. You should also have git installed in your system.
To initialize a new project, ensure that cookiecutter is in your path and run:
$ cookiecutter gh:cmeadows/fbone-marrow.git
To provision your development environment:
$ cd <your-package-name>/
$ vagrant up
You may now visit http://localhost:8931 to view your fbone-marrow Application. Now, you are all set to start developing.
- Alternative flask templates:
- Buildout project boilerplate template: https://github.com/konstantint/cookiecutter-python-boilerplate
- Blog post: http://fouryears.eu/2015/04/21/a-flask-project-template/
- Copyright 2016, Collin Meadows
- License: MIT