ericchin90 / antplanner Goto Github PK

Welcome to AntPlanner!

=== OVERVIEW ===

AntPlanner is a tool for helping students of the UC Irvine schedule classes. 
As most students know, the Schedule of Classes (Web Soc) does a sub-par job of 
displaying information in a useful manner. Planning for classes is a time-consuming task 
and Web Soc does not help at all. Ant Planner aims to ease this process by 
providing extensions to Web Soc for filtering classes and creating a more streamlined 
interface. Most importantly, a weekly calendar for seeing course times laid out in 
an organized manner, an idea inspired by Zot Scheduler, 
http://www.ocf.berkeley.edu/~mlyang/scheduler/, now defunct. 

AntPlanner is written in Python using the web.py framework and is meant to be
run on Google App Engine. If you would like to extend AntPlanner and build so it can 
be run without GAE, the pleasure is yours...fork! 

This is considered a beta release. Many features have not yet been 
implemented and there are some known issues. Beware!


=== Compatibility ===

AntPlanner runs perfectly on most browsers:

-Mozilla Firefox 3+
-Webkit browsers (Chrome, Safari)
-Internet Explorer 7+

Opera is not supported at this time. 

=== INSTRUCTIONS ===

AntPlanner uses Templetor templating system. When serving on GAE, templates need to be 
compiled before serving the pages since the Python parser module is blocked by GAE. 
After changes to templates are made, you need to issue the following before running to 
see changes:

	$python web/template.py --compile templates/
	
To run the app, use the GoogleAppEngineLauncher or issue the following :

	$dev_appserver.py .


=== DISCLAIMER ===

Ant Planner is not officially recognized by UC Irvine. The authors of this application are 
not responsible for any damages as a result of using AntPlanner. Use at your own risk! 
At the time of this release, WebSoc is version 3.2