https://github.com/semestry/sakai-mytimetable

MyTimetable tool for Sakai CLE
https://github.com/semestry/sakai-mytimetable

Last synced: 6 days ago
JSON representation

MyTimetable tool for Sakai CLE

• Host: GitHub
• URL: https://github.com/semestry/sakai-mytimetable
• Owner: semestry
• License: apache-2.0
• Created: 2013-10-10T08:32:38.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-01-10T15:38:23.000Z (almost 11 years ago)
• Last Synced: 2024-03-26T21:47:22.354Z (8 months ago)
• Language: Java
• Size: 379 KB
• Stars: 0
• Watchers: 8
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MyTimetable tool for Sakai CLE

[MyTimetable] for Sakai CLE is a [Sakai] tool that displays the upcoming activities for the user currently logged in.

## Deploying to Sakai

### Supported versions of Sakai

This tool is tested with Sakai 2.8.0 (Kernel 1.2.1).

### Extract Tomcat overlay

1. Download the [Tomcat overlay], or build it yourself (see below).

2. Unzip de archive in the Tomcat home directory `$CATALINA_HOME`.

3. Configure the tool in `$CATALINA_HOME/sakai/sakai-configuration.xml`.

4. Restart Tomcat

5. Add the MyTimetable tool to a page.

### Configuration

Settings can be configured in `sakai-configuration.xml`, which is usually found in the $CATALINA_HOME/sakai folder. A

full configuration looks like:

````

    

        

        

        

        

            

                https://timetable.institution.ac.uk/api/v0/

                https://timetable-server-2.institution.ac.uk/api/v0/

            

        

        

        

        

        

        

        

        

        

        

        

        

        

        

        

        

        

    

````

## Building Tomcat overlay

Run `./gradlew clean distZip` (*nix / Mac OS X) or `gradlew.bat clean distZip` (Windows). The 'assembly' module now

contains the Tomcat overlay in ZIP format (in folder `assembly/build/distributions/`).

## MyTimetable API

Documentation for the MyTimetable API is available at https://wiki.eveoh.nl/display/MYTT/API+Documentation.

Documentation on administring API tokens can be found at https://wiki.eveoh.nl/display/MYTT/API+tokens+and+OAuth+information.

## Source code

[Source code] is available at Github.

## Issue tracking

Please report issues via the [Github issue tracker].

## Contributing

[Pull requests] are more than welcome.

## License

    Copyright 2013 - 2014 Eveoh

    

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

    

        http://www.apache.org/licenses/LICENSE-2.0

    

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.

[MyTimetable]: http://mytimetable.net

[Sakai]: http://www.sakaiproject.org/sakai-cle

[Source code]: https://github.com/eveoh/sakai-mytimetable

[GitHub issue tracker]: https://github.com/eveoh/sakai-mytimetable/issues

[Pull requests]: https://github.com/eveoh/sakai-mytimetable/pulls

[source]: https://github.com/eveoh/sakai-mytimetable/archive/master.zip

[Tomcat overlay]: https://github.com/eveoh/sakai-mytimetable/releases