Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
karma
src
.bowerrc
.gitignore
.gitmodules
.scrutinizer.yml
.travis.yml
CHANGELOG.md
Gruntfile.js
LICENSE
README.md
bower.json
build.config.js
changelog.tpl
module.prefix
module.suffix
package.json
tools.md

README.md

FlindersTimetable

Project Brief

This project helps Flinders students find their ideal timetable for a semester.

Environment

To build the project, you'll need a modern version of Node.js, NPM and git in your classpath.

OS X

If you have homebrew installed, run

brew install nodejs git

Windows

Download and install Node.js

Download and install Github for Windows (not strictly necessary, but I like the UI. #dealwithit)

'cd' to the following directory and add the resolved path to your PATH environmental variable.

%LOCALAPPDATA%/GitHub/PortableGit_*/bin

or just manually install git somewhere sensible and add that directory to your PATH.

Installation

npm install -g grunt-cli karma bower
git clone git@github.com:TobiasWooldridge/FlindersTimetable.git
cd FlindersTimetable
npm install
bower install

Development

Continuous Building

To build the software continuously, run

grunt watch

This will start continuous builds for the project (rebuilding the project every time a file changes), and start a webserver pointing to these builds at http://localhost:1337/

A webserver is necessary if you wish to avoid browser security issues. IE still manages to break things because localhost is an intranet address, so you'll need to turn down IE's intranet security settings to test in IE.

Building

To build FlindersTimetable's application, run

grunt

in the root directory of the project and it'll compile the LESS/JS into the project's /bin directory