README.md

WaNDER! CORS Planner

CORS Planner (Facebook Page) is a powerful and elegant open source timetable builder for any university!

Now it supports:

• National University of Singapore (NUS)
• Nanyang Technological Unviersity (NTU)

You can add your university by writing some JavaScripts (Doc)!

Build

You will need Node.js.

Following packages are required to build CORS Planner:

$ npm install -g jshint uglify-js less less-plugin-clean-css

To build, run makefile.bat (Windows) or makefile.sh (UNIX). Files will be generated in folder /release.

Additionally, you will need phantomjs to crawl the latest list of modules available in each school.

Updating Data

Details of each module are crawled directly from the school's website using YQL API at run-time.

However, the list of Module Codes and Titles served in <input> box for auto-completion needs to be fetched manually:

• Get phantomjs, at schools/.../data directory, run

$ phantomjs crawl-phantomjs.js

It should generate a list.js in the same directory for use.

Contributing

• You can submit bugs through GitHub Issues or Facebook Page.

• Anyone and everyone is welcome to contribute.

Documentation

Detailed Documentation is listed in Wiki. (Working...)

Testing

All tests are written in Jasmine under folder /test. (Waiting to be rewritten!)

License

Copyright (c) 2012-2013 Wang Zhuochun. Licensed under the MIT license.