#Readme v2.0 (milestone 2)

#Timekeeper - Comparing timetables made easy Take a look at our preview site

You can also check out our video on YouTube

This project is part of NUS's orbital programme 2015.

This project helps NUS students find free time with their friends. Be it project meetings, or even a simple catchup - Timekeeper is here for you!

Contents of this README:

1. License
2. Source Code
3. Libraries/Frameworks
4. Features
5. User stories
6. Milestone 2 specific
7. Set up for local development

##1. License

This web-based application is distributed under the MIT license. Users looking to use all or any part of the code can do so but cannot hold Timekeeper liable for any use of the source code whether proper or improper. For a better understanding of the MIT license visit this link

##2. Source Code

Timekeeper is a single-page application written using html, css, javascript, and various frameworks and tools in the respective languages.

The source code for this project will be maintained in this repository.

##3. Libraries/Frameworks

Timekeeper is built upon free libraries. Users need to make sure that their browsers and the corresponding JavaScript versions are updated to the latest versions for the best performances.

Materializecss
A modern responsive front-end framework based on Material Design

jQuery
Query is a fast, small, and feature-rich JavaScript library

BackboneJS
Backbone supplies structure to JavaScript-heavy applications by providing models with key-value binding and custom events, collections with a rich API of enumerable functions, views with declarative event handling, and connects it all to your existing application over a RESTful JSON interface.

NUSMods API
NUSMods API consolidates and normalizes various bits of NUS module information.

##4.Features

• Milestone 1

  • MaterializeCSS for design
  • Ability to add and/or remove users
  • Button to refresh and update timetable
  • Name field to identify user
  • Tracking of URL entered
  • Parsing URL

• Milestone 2 :

  • Logo
  • Backbone framework for structuring data
  • Dynamically refresh timetable render
  • Identify Number of users' classes in a slot

• Allow for edits to url input to behave properly

• Rank available slots

  • Rank by custom criteria

• Cache API calls for faster performance

• Manually edit slots for customization

  • Remove manual changes

• Hide, show a user's timetable

• Social network integration for easy sharing

• Timetable/location matching

##5. User stories

##6. Milestone 2 Specific

####Comparing of timetables Users can view their timetables by pasting their NUSMods timetable URL into the URL input bar

####Adding users Users can compare more timetables by clicking on the add button to add more input bars for more URLs

####For easy testing, here are some sample URLs that can be used https://staging.nusmods.com/timetable/2015-2016/sem1?ACC3601[SEC]=A1&ACC3603[SEC]=C1&ACC3614[SEC]=G2

https://nusmods.com/timetable/2014-2015/sem2?ACC1002X[TUT]=X18&ACC1002X[LEC]=X1&ACC3601[SEC]=A2&CS1010E[SEC]=1&CS1010E[TUT]=D19&CS1010E[LAB]=4&ACC4611[SEC]=K1&MA1506[LAB]=CL5&MA1506[LEC]=SL1&MA1506[TUT]=T07

##7. Set up for local development

• Install nodejs
• npm install express
• node server basically starts https://localhost:3000