#VPR App Template Create and push static files for hosting on Amazon S3.

This stack is used by VPR to publish news apps and can be used for anything from building a blog to creating web applications.

Technology

• Flask: Used for local development

• Frozen-Flask: Freezes Flask application into a series of static files

• Jinja: Python templating language

• Bootstrap: Twitter's HTML/CSS/JS framework

• Sass: CSS extension that allows for variables, inheritance, and even logic in stylesheets

Install

1. Install virtualenv

2. Clone the repository

    $ git clone git@github.com:vprnet/app-template.git
   

3. Create Virtual Environment in project

    $ cd app-template
    $ virtualenv venv
   

4. Enter virtual environment

    $ source venv/bin/activate
   

5. Install requirements

    $ pip install -r requirements.txt
   

6. Change _config.py to config.py

    $ mv _config.py config.py
   

These settings can be configured later (see "Deploy" below)

7. Remove VPR specific code:

    $ cd app/
    $ rm -r static
    $ rm -r templates
    $ mv _static/ static
    $ mv _templates/ templates
   

##Develop

To run local server:

    $ python run.py

The project will be viewable at http://127.0.0.1:5000/

Deploy

1. Create an S3 bucket to serve content using Amazon's documentation for hosting a static website

2. Configure AWS settings in config.py

3. Freeze files and push to S3

    $ python run.py build
   

Sass and CSS

If you haven't tried one of the CSS 'meta-languages' (Sass/Less) they are well worth learning (and easy!). If, however, you want to stick to standard CSS you can do so by working with style.css the old fashioned way.

Here are some instructions for developing with Sass:

1. Check out the documentation and examples on the Sass website

2. Edit _example.scss. Valid css is valid scss, so use as much or little Sass as you like.

3. Compile. I use CodeKit, which compiles Sass into CSS, concatenates all stylesheets, and minifies them for production. It's great, but costs $25. If you don't want to spend the money, you can use Compass to compile following these instructions.

To-Do

0. Write description of project structure
1. Impliment NPR-API ingest

Author

Matt Parrilla

##Copyright and License

Copyright 2013 Vermont Public Radio

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions under the License.