Skip to content

500poundbear/nusmods

This branch is 3216 commits behind nusmodifications/nusmods:master.

Folders and files

NameName
Last commit message
Last commit date
Oct 18, 2014
Feb 9, 2015
Aug 9, 2014
Jun 19, 2013
Jul 19, 2014
Mar 5, 2013
Dec 20, 2014
Aug 9, 2014
Aug 14, 2014
Dec 30, 2014
Aug 3, 2014
Aug 17, 2014
Dec 20, 2014
Aug 21, 2012
Jan 6, 2015
Aug 3, 2014
Dec 28, 2014
Dec 19, 2014
Dec 19, 2014
Jan 11, 2015

Repository files navigation

Setup with Vagrant

Prerequisites

Setup

$ pip install ansible
$ vagrant up

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

Setup without Vagrant

Prerequisites

Setup

Install the necessary packages.

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

Make a copy of the config file. Add Facebook App credentials (needed only by barenus.php).

$ 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.

About

NUS CORS Module Finder & Timetable Builder (Unofficial)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 53.1%
  • Handlebars 21.8%
  • CSS 13.0%
  • ApacheConf 7.9%
  • HTML 2.7%
  • PHP 1.3%
  • Ruby 0.2%