Yunheng/nusmods

NUS CORS Module Finder & Timetable Builder (Unofficial)

NUSMods

Talk to us!

• Gitter:
• HipChat: NUSMods Dev HipChat

Setup with Vagrant

Prerequisites

• Vagrant
• VirtualBox

Setup

$ pip install ansible
$ vagrant up

Once it's up, do a vagrant ssh to enter the development environment.

Setup without Vagrant

Prerequisites

• Bundler
• Node.js

Setup

Install the necessary packages.

$ npm install -g bower grunt-cli
$ npm install
$ bower install
$ bundle install

Make a copy of the config file. If you are working on barenus.php, add Facebook App credentials into the file.

$ cp ./app/config.json.dist ./app/config.json

Building for Development

$ grunt serve

Building for Production

To get a complete, minified, production build under dist/:

$ grunt

Alternatively, a version that ignores jshint warnings:

$ grunt build

Deploying to Production

Change the host in the production inventory file provisioning/production and execute the Ansible playbook against it:

$ ansible-playbook provisioning/production.yml -i provisioning/production

Working with the NUSMods API

NUSMods is set up to work with the remote API at http://nusmods.com/api/ by default. To work with a local copy of the API:

$ git submodule update --init
$ cd api
$ npm install
$ grunt

The development server serves the files generated in api/app/api under /api/, so change baseUrl under app/scripts/config.json to point to /api/.

Optional Dependencies

• PHP for export, URL shortening, redirect and Facebook API proxy scripts.
• YOURLS for URL shortening.
• wkhtmltopdf and wkhtmltoimage for pdf and image export. Using the static binaries is suggested, as compiling with all the features of the static build needs a custom patched version of QT, which takes a long time to build.
• Facebook PHP SDK for Facebook API proxy.
• To install the PHP dependencies, simple do:

$ composer install

License

Copyright (c) 2015 NUS Modifications. Licensed under the MIT license.