Uptown Saturday Night

uptown-prototype.appspot.com

Setting Up

• Download and Install Python 2.7
• Download and Install GAE Python SDK
• Download and Install Git
• Checkout this repository git clone https://github.com/theMagicalKarp/uptown-prototype.git uptown
• Start GAE SDK and select this project.

Running Unit Tests

To run unit tests with included frameworks use the testing script. With the script you can target the GAE SDK and testing directory. For example python test.py /usr/local/google_appengine . runs all the unit tests.

Libraries and Frameworks Used

• Google App Engine Web framework for running our python enviroment
• Flask URL Routing
• Flask-Login User Authentication
• Jinja2 HTML templating
• Bootstrap HTML Styling
• jQuery Wrapper for JavaScript... Also required for bootstrap... D:

What's Going On?!

/app.yaml: Basic config that Google App Engine uses to understands how to run our application. This is the first thing ran when starting the server.

/libs/: Contains external python libraries such as Flask, werkzeug, ect...

/app/views.py: Contains instructions of how to map our application to specific urls. For example this http://uptown-prototype.appspot.com/ is generated from this

@blueprint.route('/', methods=['GET'])
def home():
    return render_template('home.html')

/app/models/students.py: This holds information on how our student objects should be stored in the database.

/app/templates/: This directory holds html template files that are to be rendered by jinja2. Each html file extends a base html file that describes how each page should look. This helps enforce consistancy among all of the pages. You can find out more about jinja2 templating here.

/app/models/isu.py: This holds information about Iowa States majors and colleges staticly in memory for quick refrence in our application.

/app/models/user.py: This holds information about our user models and authentication.