dev_tips.txt

# KVM-based Discoverable Cloudlet (KD-Cloudlet) 
# Copyright (c) 2015 Carnegie Mellon University.
# All Rights Reserved.
# 
# THIS SOFTWARE IS PROVIDED "AS IS," WITH NO WARRANTIES WHATSOEVER. CARNEGIE MELLON UNIVERSITY EXPRESSLY DISCLAIMS TO THE FULLEST EXTENT PERMITTEDBY LAW ALL EXPRESS, IMPLIED, AND STATUTORY WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF PROPRIETARY RIGHTS.
# 
# Released under a modified BSD license, please see license.txt for full terms.
# DM-0002138
# 
# KD-Cloudlet includes and/or makes use of the following Third-Party Software subject to their own licenses:
# MiniMongo
# Copyright (c) 2010-2014, Steve Lacy 
# All rights reserved. Released under BSD license.
# https://github.com/MiniMongo/minimongo/blob/master/LICENSE
# 
# Bootstrap
# Copyright (c) 2011-2015 Twitter, Inc.
# Released under the MIT License
# https://github.com/twbs/bootstrap/blob/master/LICENSE
# 
# jQuery JavaScript Library v1.11.0
# http://jquery.com/
# Includes Sizzle.js
# http://sizzlejs.com/
# Copyright 2005, 2014 jQuery Foundation, Inc. and other contributors
# Released under the MIT license
# http://jquery.org/license


Setup and run from this directory:

python setup.py egg_info

paster serve --reload development.ini

Creating a Controller
 - Create controller inside the ./controllers folder, naming the class <ContName>Controller, deriving from pycloud.manager.BaseController
    - Each method to be an action needs to have a GET_ or POST_ prefix in its name; ie, GET_<actioname>(self):
 - Import controller in ./controllers/__init__.py
    from <module> import <ControllerClass>
 - In ./config/routing.py \, add a route for each of the actions (this also needs to be done each time an action is added)
    connect('<nickname>', '/<URL_path>', controller='<controllermodulename>', action='<actioname>')
    
Creating a Page
 - Create an HTML file with the .html extension inside the ./templates folder, naming the file <pagename>page.html
 - In ./lib/pages.py, add a line declaring the class for the page
    class <PageName>Page(BasePage): pass
 - To use the page from a Controller, import the page class, and then do
    page = <PageName>Page()
    return page.render()