59 lines
2.1 KiB
Markdown
59 lines
2.1 KiB
Markdown
# Tiss2Go
|
|
|
|
Tiss2Go is a ruby on rails gateway server for the TISS (TU Wien
|
|
Informations-Systeme und Services) application. It was made for the course
|
|
_Ruby on Rails Business Programming_ for 2020SS.
|
|
|
|
It offers an easy and mobile friendly interface for searching through the TISS
|
|
API. Searchable are TU related subjects like people, courses, available theses
|
|
and projects.
|
|
|
|
## User Guide
|
|
|
|
To be able to use the Tiss2Go application, one must create a personal user
|
|
account consisting of a username, which is represented by an email address, and
|
|
a password.
|
|
|
|
After logging in, the user is redirected to the main search view. Here, the
|
|
user can input a search term and check his/her search topic with the radio
|
|
buttons directly below the input field. Empty searches are not allowed and
|
|
therefore blocked!
|
|
|
|
The search is then computed and provides the user with the results, if it could
|
|
find something. Found items can be favorited with the _heart_-button or the
|
|
corresponding detail view can directly be accessed by _touching_/_clicking_ on
|
|
the entry.
|
|
|
|
On the detail view the user can also add the subject to the related favorites
|
|
and if the subject is favorited, can also save annotations and keywords.
|
|
|
|
Through the main navigation bar the stored favorites can be accessed easily.
|
|
The favorites themselves are also grouped in people, courses, theses and
|
|
projects. If favorites are stored, the main subject view presents the stored
|
|
information in a table-like view. The entries can be sorted either ascendingly
|
|
or descendingly by clicking on the corresponding table header. The entries can
|
|
also be deleted directly in this view and it is possible to access the related
|
|
details view, too.
|
|
|
|
If the user wants to print his/her favorites, it can also be done directly by
|
|
pressing the PRINT button in the favorite's main menu. A toggle beneath allows
|
|
for hiding/displaying the stored annotations.
|
|
|
|
The user can also print the detail view with a print button on the detail view.
|
|
|
|
## Requirements
|
|
|
|
- Ruby version 2.7.0
|
|
- Rails version 6.0.2.1
|
|
|
|
## Setup
|
|
|
|
- `rake db:create`
|
|
- `rake db:migrate`
|
|
- `rails server`
|
|
|
|
## Authors
|
|
|
|
Eidelpes Tobias - 01527193
|
|
Zeisler Marco - 01628030
|