A simple scaffold / template for Flask modules (aka sub apps)
Python C JavaScript Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Author: Jason Giedymin <jasong _[_a-t_]_ apache [dot] org>

== What is this? ==
Use this scaffold / template as a basis for a Subapp / Module based Flask 
application using subdomains and subapps content. There is also an example
of using a subapp / module to extend root app space.

The application relies on Fabric to start, and includes staging
functionality to auto install all required dependencies.

== How To Use this? ==
First you'll need to edit your hosts file to direct the 'dummy' subdomain to localhost.
1. Edit /etc/hosts
2. Add an entry for "  dummy.localhost"

Start installing dependencies and run the app:
1. Clone this repo
2. pip install fabric
3. cd Flask-Module-Scaffold/src
4. fab -l #Lists all commands
5. fab staging_local #Creates virtualenv and pip installs
6. fab start_dev_server #Starts the dev server

== The app is running, now what? ==
Navigate to these pages:
    # Served from the 'frontend' subapp/module
    # Templates and CSS served from frontend/[static,templates]
    # Served from the 'dummy' subbapp/module
    # Templates and CSS served from dummy/[static,templates]
    # Served from the 'root' subapp/module using the main apps static/template
    # directories.
    # Templates and CSS served from root myapp/[static,templates]
    # To prove this, apps/root/ is devoid of the static and templates directories.

== References ==
Flask:  http://flask.pocoo.org/
        "Flask is a microframework for Python based on Werkzeug, Jinja 2
        and good intentions. And before you ask: It's BSD licensed!"

Fabric: http://docs.fabfile.org/en/1.0.1/index.html
        "Fabric is a Python (2.5 or higher) library and command-line 
        tool for streamlining the use of SSH for application deployment
        or systems administration tasks."
== Noob? ==
This is a python repo using python tools and frameworks.