Unofficial course planning platform for National University of Singapore
JavaScript HTML CSS ApacheConf Other
Latest commit 5fe034d Jan 21, 2017 @yangshun yangshun Remove sem 2 data alert

README.md

NUSMods Code Climate Dependency Status devDependency Status Build Status

ghit.me

Talk to us!

Setup with Vagrant

Prerequisites

Setup

On Unix/Mac:

$ pip install ansible==2.1.0.0
$ vagrant up

On Windows:

PS> 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 npm@3.10.3
$ npm install -g gulp-cli@1.2.2
$ npm install

If you are working on news.php, make a copy of /app/config/secrets.json.example in the same directory and call it secrets.json. Add your Facebook App credentials into the file secrets.json.

Building for Development

First, SSH into the vagrant box (this command has to be run in the directory that Vagrantfile is in):

$ vagrant ssh

Run the development environment:

$ npm start

Visit localhost:8080 to see your local instance of NUSMods.

Building for Production

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

$ npm run 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 # starts the crawling process in nusmods-api

The development server serves the files generated in api/app/api under /api/, so change baseUrl under app/config/application.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, simply do:
$ composer install

License

Copyright (c) 2017 NUSModifications. Licensed under the MIT license.