flask-boilerplate
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Skeleton @ 88f0361
flask_application
.gitmodules
LICENSE
README.md
fabfile.py
flask_application.wsgi
requirements.txt
runserver.py

README.md

Flask-Boilerplate

[Currently, because of the dependency on the Fabric module, this project is Python 2 only...for now.]

This is a bootstrap site for Flask that utilizes Fabric and Skeleton to get you up-and-running with a responsive Flask web app.

Getting Started

It is suggested that you use a Virtualenv, especially with virtualenvwrapper when developing a website using this boilerplate. This will allow you to isolate your organization's development environment from the rest of your system, ensuring that you are developing with the proper software.

To do development work on a new website, run the following commands from the root directory of a cloned copy of this repository to get started:

First, install all required modules:

  • pip install -r requirements.txt

Then, build and customize the boilerplate:

  • fab init:site_name=<sitename>
    • Where "<sitename>" is replaced with the hostname of your new site
  • fab server
    • Will run a local dev server on http://localhost:8080
  • fab help
    • Print a list of commands available in the fabfile.

Lastly, start editing your site, located in the flask_application directory.

You will then be able to access the website at http://localhost:8080. Changes in the code will automatically reload the web server when necessary.

In production, the server uses WSGI, so please don't rename or move __init__.py in the root of the repository.