The template used for projects hosted on S3 with Webfaction running crons and responding to AJAX requests
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
main
.gitignore
LICENSE
README.md
requirements.txt
runserver.py
upload_s3.py

README.md

#VPR App Template Used to create and push static web applications 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 more advanced 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

  • Compass: A Sass "framework"

  • Grunt: A JavaScript task runner used for concatenation, minification, preprocessing and image optimization that runs in the background during development and refreshes the page when JS changes and injects CSS changes into the pages.

Set Up

  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. Copy _config.py as config.py

     $ cp main/_config.py main/config.py
    

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

  1. Install grunt modules (read this if getting started with Grunt)

     $ cd main/static
     $ npm install
    

##Develop

To get grunt running in the background:

    $ cd main/static
    $ grunt

To run local server, get back to project root and run:

    $ python runserver.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 runserver.py freeze
    

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.