From b62cc741354a63929c48253500c43044c66a7dda Mon Sep 17 00:00:00 2001 From: Pfingstfrosch Date: Sat, 20 Jun 2020 19:35:40 +0200 Subject: [PATCH] update --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 1fe3a4a..2d4bd41 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,44 @@ 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. + +To be able to use the Tiss2Go application, one must create a personal user account +consisting of a username, which is represented by the email and a password. + +After logging in, the user is redirected directly on 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 directly 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 ascending or descending +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 favorites main menu. A toggle beneath allows for +hiding/displaying the stored annotations. + +If wanted the user can also print the detail view with a print button on the detail view. + + +# META +Used rails version: 2.7.0p0 +Used ruby version: 6.0.2.1 + + # SETUP 'rake db:create' 'rake db:migrate'