[EnglishSubtitled] Back-end

Repozytorium zawiera back-end dla systemu będącego projektem inżynierskim.

Komponenty systemu

• Aplikacja serwerowa (to repozytorium)
• Aplikacja kliencka
• Narzędzia administracyjne

Uruchamianie

Aplikacja wymaga programów docker i docker-compose w celu uruchomienia lokalnej bazy danych:

sudo docker-compose up -d uruchamia bazę danych w tle.

Przykładowe lekcje

Aby dodać do bazy danych aplikacji przykładowe lekcje, należy wykonać skrypt skrypty/skrypty.py (wymaga Python 3 z biblioteką Requests) lub wykonać zawarte w nim zapytanie w inny sposób.

API

Pogrubione wpisy są szczególnie istotne dla klienta.

Wszystkie endpointy oprócz lessons [GET] i films [GET] wymagają nagłówka Authorization z wartością Facebookowego access tokena.

• lessons [GET] - lista wszystkich lekcji, bez tłumaczeń;
• lessons [POST] - tworzenie nowych lekcji na podstawie listy obiektów zawartej w treści żądania [Wymaga uprawnień admina];
• lessons [PUT] - tworzenie lub modyfikacja istniejących lekcji na podstawie listy obiektów zawartej w treści żądania [Wymaga uprawnień admina];
• lessons/{lessonId} [GET] - pełna reprezentacja pojedynczej lekcji (wraz z tłumaczeniami);
• lessons/{lessonId} [DELETE] - usuwanie lekcji o ID lessonId [Wymaga uprawnień admina];
• films [GET] - lista wszystkich filmów, każdy film zawiera listę wszystkich związanych z nim lekcji (bez tłumaczeń) - stąd wynik zapytania zawiera wszystkie lekcje;
• films/{filmTitle} [GET] - pojedynczy film, o tytule filmTitle, z listy zwracanej przez films [GET];
• bookmarks [GET] - lista słówek dodanych przez uwierzytelnionego w tym zapytaniu użytkownika do słownika;
• bookmarks [PUT] - dodawanie tłumaczenia (umieszczonego w body) do słownika uwierzytelnionego w tym żądaniu użytkownika;
• bookmarks/remove [PUT] - usuwanie tłumaczenia (umieszczonego w body) ze słownika uwierzytelnionego w tym żądaniu użytkownika (zaimplementowane w ten sposób, gdyż DELETE nie musi wspierać body);
• progress [GET] - lista lekcji obecnie dostępnych dla użytkownika, z podziałem na wypożyczone i ukończone;
• progress/{lessonId} [PUT] - przesłanie statystyk lekcji w JSONie w request body (struktura JSONa jest zdefiniowana w LessonResultsDto.java), będące jednocześnie stwierdzeniem ukończenia lekcji; zwraca listę odblokownych przez to osiągnięć;
• progress/{lessonId} [DELETE] - porzucenie nieukończonej pożyczonej lekcji tak, by nie pojawiała się już w wyniku zapytania progress [GET] (nie usuwa ukończonych lekcji);
• achievements [GET] - lista osiągnięć zdobytych przez użytkownika (wraz z timestampem);
• users [GET] - informacja, czy uwierzytelniony użytkownik jest administratorem.

Autorzy

Justyna Maciąg, Paweł Taborowski, Agnieszka Warchoł