Merge branch 'master' into master

Przybylski/awionika/wizja_projektu.md

@@ -0,0 +1,364 @@
+---
+author:
+- Wojciech Kubiak
+- Piotr Józefowicz
+- Sebastian Wawrzyn
+title: 
+- Dokument wizji dla projektu Awionika do rakiet sondażowych
+---
+
+# Executive summary
+
+Dokument dotyczy projektu realizowanego w ramach przedmiotu projekt
+inżynierski. Niniejszy dokument służy przedstawieniu przeznaczenia
+tworzonego systemu, jego głównych cech i przyjętych założeń. Grupą
+docelową dla projektu jest koło naukowe na politechnice poznańskiej PUT
+RocketLab, zajmujące się budową rakiet i silników rakietowych. Potrzebny
+jest komputer pokładowy do rakiety oraz aplikacje umożliwiające obsługę
+testów rakiet i silników. Nasz projekt ma dostarczyć:
+
+-   Aplikację desktopową pozwalająca wyświetlać dane na żywo z testów,
+    konfigurować ustawienia modułów komputera pokładowego oraz
+    zapisywać/usuwać dane z pamięci podręcznej modułów.
+
+-   Komputer pokładowy posiadający układ wyzwalający separację oraz
+    zbierający dane telemetryczne o locie, które będą mogły być
+    przekazywane na żywo do aplikacji poprzez nadajnik i odbiornik.
+
+-   Aplikację webową służącą jako baza danych testów oraz odgrywającą
+    rolę wizytówki koła
+
+# Cel i grupa docelowa
+
+Grupą docelową dla projektu jest koło naukowe na Politechnice
+Poznańskiej PUT RocketLab. Koło zajmuje się budową rakiet i silników
+rakietowych oraz rozwija systemy awioniczne i naziemne do ich
+testowania. Potrzebny jest komputer pokładowy do rakiety, który będzie
+odpowiadał za jej lot, zapisywanie danych z tego lotu, oraz lokalizację
+rakiety po jej wylądowaniu. Potrzebna jest również aplikacja, która
+będzie pełniła funkcję kontrolera lotów/testów. Takie testy generują
+dużą liczbę danych, które ciężko uporządkować więc potrzebne jest też
+miejsce, w którym będzie można je porządkować i wyświetlać w przejrzysty
+sposób. Koło nie posiada też strony internetowej - tak zwanej wizytówki,
+która ma budować rozpoznawalność w internecie i pomóc w kontakcie
+przyszłym kandydatom na członków koła.\
+Projekt oprócz komputera pokładowego będzie się składał z dwóch
+aplikacji -- aplikacji webowej oraz aplikacji desktopowej. Aplikacja
+desktopowa ma odgrywać rolę kontrolera testów. To, że aplikacja jest
+desktopowa, wynika z faktu, że testy zazwyczaj wykonywane są w miejscach
+bez dostępu do internetu. Aplikacja webowa będzie pełniła funkcję
+wizytówki oraz bazy danych testów. Członkowie koła będą posiadali login
+i hasło do aplikacji, gdzie będą katalogowane dane historyczne z testów.
+Dane będzie można eksportować w wygodnym formacie, a także wyświetlać w
+formie wykresów i tabelek z danymi. Strona będzie miała możliwość
+wprowadzenia danych ręcznie, jednak preferowaną opcją będzie dodawanie
+danych przez aplikację desktopowa, która to zrobi w sposób
+zautomatyzowany. Aplikacja desktopowa będzie umożliwiała wyświetlanie
+danych z testów rakiet oraz silników na żywo. Po teście dane będą
+przekazywane do aplikacji webowej, jeśli będzie dostęp do internetu.
+Jeśli nie będzie dostępu, to dane zostaną zapisane w pamięci komputera i
+przekazane od razu po podłączeniu komputera do Internetu. Aplikacja
+desktopowa ma również dać możliwość konfiguracji modułów elektroniki
+komputera pokładowego rakiety oraz odczytywania i zapisywania z nich
+danych. Pobrane dane będą od razu przekazywane do chmury tak jak w
+przypadku testu na żywo. Będzie również możliwa zmiana konfiguracji tych
+modułów-zmiany ustawień parametrów programu na danym module (np. ilość
+bitów na sekundę podczas wysyłania danych, częstotliwość, moc anteny),
+są to parametry, które muszą być zmieniane podczas czasu życia modułu.
+Ta funkcjonalność ma na celu zapewnić większe bezpieczeństwo podczas
+zmiany tych parametrów. Parametry nie będą zmieniane poprzez wgranie
+nowego kodu tylko przez aplikacje, dzięki temu na samym urządzeniu nie
+trzeba będzie zmieniać kodu źródłowego.\
+Klientowi zależy na tym, aby pozyskać z rakiety dane, które pozwolą
+sprawdzić, czy rakieta osiągnęła oczekiwane parametry lotu zgodne z
+wcześniejszą symulacją takie jak apogeum, prędkość, liczba macha czy
+przyspieszenie. W tym celu muszą dokonać pomiarów fizycznych za pomocą
+odpowiednich czujników takich jak akcelerometr, barometr, magnetometr
+czy żyroskop, a następnie zapisać te dane i wyświetlić je w czytelnej
+formie w celu ich analizy. Komputer pokładowy będzie umożliwiał zebranie
+powyższych danych, a także wyzwolenie separacji/spadochronu w dwóch
+różnych konfiguracjach: poprzez automatyczne wykrycie spadku swobodnego
+(apogeum). Rakieta będzie też wyposażona w lokalizator, który będzie
+umożliwiał odnalezienie rakiety po lokalizacji GPS wysłanej za pomocą
+komunikacji bezprzewodowej LORA.
+
+# Rynek
+
+Wyposażenie pokładowe rakiety (awionika) składa się głównie z dwóch
+części: komputera pokładowego i lokalizatora. Komputery pokładowe
+znajdujące się na rynku mają wysoką cenę i większość z nich, nie
+oferuje, aplikacji do zbierania danych, przez co robi się z nimi bałagan
+i trzeba dbać samemu o to, by te dane katalogować. Gotowe lokalizatory,
+mimo że zaawansowane również są bardzo drogie.
+
+## Przykłady produktów na rynku
+
+-   Dużym zainteresowaniem na świecie cieszą się amerykańskie
+    [EggTimery](http://eggtimerrocketry.com/home/altimeters-av-bay/).
+    Posiadają one wiele różnych konfiguracji komputerów oraz
+    lokalizatorów. Mają jednak one dość wysokie ceny modułów i nie
+    oferują zintegrowanej aplikacji, która umożliwiałaby analizę danych,
+    musimy korzystać z osobnych programów.
+
+-   Dostępne są [niemieckie komputery
+    pokładowe](https://www.rocketronics.de/shop/de/altimax-g3-standard.html?fbclid=IwAR2Btg-xkFvGJoPM6sU9-zkdCB5SZMVawdttTxnr6m8iG2iS46GtkmWs8Fc)
+    firmy Rocketronics oferujące wysoką jakość danych oraz dokładną
+    separację. Ich aplikacja nie umożliwia podglądu danych na żywo. Nie
+    ma w nich lokalizatorów i mają wysoką cenę.
+
+-   [Lokalizator
+    Featherweight](https://www.featherweightaltimeters.com/featherweight-gps-tracker.html)
+    (koszt to 610-2000 zł) - wysoka cena, zawiera aplikację, ale do tego
+    potrzebny jest jeszcze komputer pokładowy. 
+
+-   Jeden z najtańszych i najpopularniejszych sposobów (przynajmniej w
+    Polsce) na lokalizację rakiety polega na używaniu taniego
+    [lokalizatora](https://abc-rc.pl/product-pol-7625-Lokalizator-GPS-TK102B-Tracker-GPS-Sledzenie-w-WWW.html),
+    który wysyła podstawowe dane telemetryczne dzięki modułowi GPS i
+    GSM. Nie są to jednak produkty przeznaczone konkretnie do rakiet i
+    nie mogą zostać zintegrowane z komputerem pokładowym. 
+
+-   Nowością jest komputer pokładowy
+    [Signal-R2](https://bps.space/shop/signal-r2) z aplikacją na telefon
+    (koszt to ok 1400 zł). Aplikacja dostępna na platformy android oraz
+    iOS jest zintegrowana z komputerem pokładowym. Cały system
+    komunikacji jest oparty na Bluetooth, co daje zasięg 10 metrów,
+    dlatego nie można używać aplikacji do odczytów danych na żywo
+    podczas lotu. Aby uzyskać szerszy dostęp do dokumentacji, kodów
+    źródłowych i informacji na temat projektu trzeba dodatkowo
+    miesięczne płacić za subskrypcje na specjalnej platformie Patronite.
+
+# Opis produkt
+
+## Aplikacja webowa
+
+-   wizytówka koła
+
+-   dane z testów będzie można zapisywać na serwerze w celu stworzenia
+    historii testów
+
+-   eksport danych GPS w formacie KML (trajektoria lotu)
+
+-   eksport danych telemetrycznych do Excel'a
+
+-   import danych pomiarowych z pliku
+
+-   wyświetlenie danych historycznych (z testów)
+
+-   wyświetlenie danych historycznych w formie live (z testów)
+
+-   wyszukiwanie testu po nazwie i dacie
+
+-   kategoryzacja danych telemetrycznych (historia testów) przypisana do
+    testu
+
+## Aplikacja desktopowa
+
+-   pomiary z rakiety obrazowane na żywo:
+
+    -   wykres prędkości od czasu,
+
+    -   wykres przyspieszenia od czasu,
+
+    -   wykresy orientacji XYZ,
+
+    -   wykres wysokości i wychylenia w osiach XYZ od czasu,
+
+    -   wyświetlenie lokalizacji GPS na mapie (Google Maps)
+
+-   obrazowane danych z hamowni na żywo
+
+    -   wykres ciągu do czasu
+
+    -   wykres ciśnienia do czasu
+
+-   dane po teście rakiety czy silnika będą zapisywane na serwerze
+
+-   zgrywania/usuwanie danych z modułów elektronicznych
+
+-   zmiana konfiguracji modułów elektronicznych
+
+## Elektronika
+
+-   dokonywanie pomiarów podczas lotu (prędkość, przyspieszenie,
+    wysokość, wychylenia w osiach XYZ) 
+
+-   lokalizacja GPS oraz pomiary wysyłane do stacji naziemnej za
+    pośrednictwem komunikacji bezprzewodowej LORA 
+
+-   wykrycie apogeum (spadku swobodnego) pozwalające wyzwolić
+    separacje/spadochron
+
+-   wyzwolenie separacji, spadochronu poprzez odpalenie zapalnika
+    elektrycznego 
+
+-   przesyłanie danych do stacji naziemnej przez moduł komunikacyjny 
+
+-   odbieranie danych przez odbiornik
+
+-   odpalenie drugie spadochronu na określonej wysokości
+
+-   przekazywanie danych do aplikacji desktopowej
+
+-   zapisywania danych do pamięci modułu
+
+-   odczytywanie danych z pamięci modułu
+
+-   zmiana konfiguracji modułu
+
+# Zakres i ograniczenia
+
+## Skład zespołu
+
+-   Wojciech Kubiak - systemy wbudowane - arduino, c++, FreeRTOS, python
+
+-   Sebastian Wawrzyn - backend - .NET Core, C# , Docker, NoSql
+
+-   Piotr Józefowicz - frontend - Vue.js, typescript
+
+## Kamienie milowe
+
+-   I faza, I semestr (02.2020 - 07.2020):
+
+    -   Przygotowanie prototypu aplikacji
+
+    -   Przygotowanie backlogu dla projektu w systemie Trello,
+        opracowanie funkcjonalności, user stories
+
+    -   Rozpoczęcie prac programistycznych nad aplikacją
+
+    -   Rozpoczęcie prac programistycznych nad komputerem pokładowym 1.0
+
+    -   Testowanie komputera pokładowego
+
+    -   Ukończenie MVP aplikacji i komputera pokładowego
+
+    -   Poddanie MVP testom funkcjonalnym
+
+-   II faza, II semestr(10.2020 - 01.2021):
+
+    -   Uaktualnienie dokumentacji i Trello
+
+    -   Kontynuacja prac programistycznych nad aplikacjami
+
+    -   Kontynuacje prac programistycznych nad komputerem pokładowym
+
+    -   Rozpoczęcie prac nad nadajnikiem i odbiornikiem
+
+    -   Testowanie komputera pokładowego oraz elektroniki naziemnej
+
+    -   Ukończenie aplikacji wraz ze wszystkimi zdefiniowanymi
+        funkcjonalnościami
+
+    -   Integracja aplikacji z elektroniką
+
+    -   Testy integracyjne
+
+    -   Wdrożenie aplikacji na publiczną domenę
+
+## Harmonogram
+
+MVP produktu zostanie wypracowane i przedstawione do końca czerwca 2020
+roku, zawierać będzie funkcjonalności takie jak:
+
+-   Komputer pokładowy 1.0:
+
+    -   Dokonywanie pomiarów telemetrycznych
+
+    -   Zapis danych na kartę SD
+
+    -   Wyzwolenie separacji za pomocą timera
+
+    -   Odpalenie zapalnika elektrycznego
+
+-   Aplikacja internetowa (frontend):
+
+    -   Stworzenie konta użytkownika, logowanie
+
+    -   Dodawanie testów z pliku
+
+    -   Wyświetlanie danych z testów
+
+    -   Przegląd danych historycznych
+
+    -   Zintegrowania aplikacji webowej z REST API
+
+-   Aplikacja serwerowa, REST API:
+
+    -   Dodanie serwisów REST pozwalających na operacje wymienione w
+        punkcie "Aplikacja internetowa"
+
+    -   Zintegrowania API z bazą danych
+
+    -   Wdrożenie aplikacji na środowisko testowe
+
+Druga wersja produktu wypracowana i oddana do stycznia 2021 roku,
+obejmować będzie:
+
+-   Wszystkie funkcjonalności zdefiniowane w MVP
+
+-   Komputer pokładowy 2.0:
+
+    -   Układ wyzwolenia separacji
+
+    -   Komunikacja z nadajnikiem
+
+    -   Konfiguracja modułu
+
+    -   Zapis danych na pamięć flash
+
+-   Nadajnik/Lokalizator:
+
+    -   Lokalizacja GPS oraz redundantny system prędkości wysokości
+        przyspieszenia
+
+    -   Komunikacja bezprzewodowa LORA
+
+    -   Konfiguracja modułu
+
+-   Elektronika naziemna/Odbiornik:
+
+    -   Konfiguracja modułu
+
+    -   Odbieranie danych od komputera pokładowego (LORA)
+
+    -   Przekazywanie danych do serwera za pomocą REST API
+
+    -   Przekazywanie danych do kolejnych urządzeń za pomocą Seriala
+
+-   Aplikacja internetowa (frontend):
+
+    -   Wyświetlanie i gromadzenie danych historycznych testów
+
+    -   Wyświetlanie testów historycznych w postaci live
+
+    -   Eksport testów do plików
+
+    -   Widok podsumowania testu
+
+    -   Profil użytkownika
+
+-   Aplikacja desktopowa:
+
+    -   Wyświetlanie danych z testów live (wykresy)
+
+    -   Wyświetlanie lokalizacji za pośrednictwem Google Maps
+
+    -   Konfigurowanie płytki
+
+    -   Odczyt danych z płytki
+
+    -   Usuwanie danych z płytki
+
+-   Aplikacja serwerowa, REST API:
+
+    -   Dodanie serwisów REST pozwalających na operacje wymienione w
+        punkcie "Aplikacja internetowa"
+
+    -   Dodanie serwisów REST pozwalających na operacje wymienione w
+        punkcie "Aplikacja desktopowa"
+
+    -   Wdrożenie aplikacji na środowisko produkcyjne
+
+Ograniczeniem projektu jest hosting, nie wiadomo czy politechnika
+udostępni nam domenę oraz otworzy porty na zewnątrz.

Przybylski/awionika/wymagania_projektowe.md

@@ -0,0 +1,515 @@
+---
+author:
+- Wojciech Kubiak
+- Piotr Józefowicz
+- Sebastian Wawrzyn
+title: 
+- Dokument wymagań projektowych
+---
+
+# Elementy składowe projektu (produkty projektu)
+
+## Semestr I
+
+-   Aplikacja webowa
+
+-   Komputer pokładowy (MVP)
+
+-   Aplikacja serwerowa - REST API (WEB)
+
+-   Relacyjna baza danych
+
+-   Prototyp interfejsu użytkownika aplikacji webowej
+
+-   Repozytorium git zawierające kod aplikacji, API, elektroniki
+
+-   Tablica projektowa -- Trello
+
+## Semestr II
+
+-   Komputer pokładowy
+
+-   Nadajnik
+
+-   Odbiornik
+
+-   Wizytówka
+
+-   Aplikacja webowa
+
+-   Aplikacja desktopowa
+
+-   Aplikacja serwerowa lokalna
+
+-   Baza danych NoSql
+
+# Granice projektu
+
+-   Produkty zawarte:
+
+    -   1\. Wyszczególnione produkty projektu
+
+-   Funkcjonalności nie zawarte:
+
+    -   Integracja z systemem APRS, wiele urządzeń lokalizacyjnych ma tę
+        funkcję, jednak zaimplementowanie jej jest zbyt czasochłonne.
+
+    -   Integracja z innymi komputerami pokładowymi, format danych różni
+        się w zależności od komputera.
+
+# Lista wymagań funkcjonalnych
+
+## Komputer pokładowy
+
+-   Dokonywanie pomiarów telemetrycznych (barometr, żyroskop,
+    akcelerometr)
+
+-   Zapis danych na flash (format tekstowy)
+
+-   Odpalenie zapalnika elektrycznego
+
+-   Automatyczne wyzwolenie separacji za pomocą barometru w apogeum
+
+-   Wyzwolenie separacji na żądanej wysokości
+
+-   Konfiguracja/kontrola modułu:
+
+    -   zmiana parametrów uruchomieniowych
+
+    -   odczyt danych z flash
+
+    -   czyszczenie pamięci flash
+
+## Nadajnik/Lokalizator
+
+-   Lokalizacja GPS oraz redundantny system prędkości wysokości
+    przyspieszenia
+
+-   Komunikacja bezprzewodowa LORA (połączenie jednokierunkowe)
+
+-   Konfiguracja/kontrola modułu:
+
+    -   zmiana parametrów uruchomieniowych
+
+    -   odczyt danych z flash
+
+    -   czyszczenie pamięci flash
+
+## Aplikacja internetowa
+
+-   Logowanie za pomocą Auth0
+
+-   Wizytówka koła:
+
+    -   informacje o kole
+
+    -   formularz kontaktowy
+
+    -   prezentacja projektów koła
+
+-   Zarządzanie użytkownikami na koncie administratora:
+
+    -   dodawanie i usuwanie użytkowników
+
+    -   zmiana danych użytkownika
+
+    -   nadawanie i odbieranie uprawnień użytkownikom
+
+-   Dodawanie pomiarów z pliku (json, csv)
+
+-   Wyświetlanie danych z testów (wykresy)
+
+-   Przegląd danych historycznych
+
+-   Wyświetlanie testów historycznych w postaci live
+
+-   Zintegrowania aplikacji webowej z REST API
+
+-   Eksport testów do plików (json, excel)
+
+-   Eksport trajektorii lotu rakiety do pliku KML (Google earth)
+
+-   Profil użytkownika, możliwość zmiany nazwy użytkownika, imienia,
+    nazwiska, e-maila, hasła
+
+## Aplikacja desktopowa
+
+-   Wyświetlanie danych z testów live (wykresy)
+
+-   Wyświetlanie lokalizacji za pośrednictwem Google Maps
+
+-   Konfigurowanie modułów elektronicznych
+
+-   Odczyt/Zapis danych z modułów elektronicznych
+
+-   Wysyłanie testów na serwer
+
+-   Zapis pomiarów w plikach json
+
+## Aplikacja serwerowa, REST API
+
+-   Dodanie serwisów REST pozwalających na operacje wymienione w punkcie
+    "Aplikacja internetowa"
+
+-   Dodanie serwisów REST pozwalających na operacje wymienione w punkcie
+    "Aplikacja desktopowa"
+
+-   Zintegrowanie API z bazą danych
+
+-   Wdrożenie aplikacji na środowisko testowe
+
+-   Wdrożenie aplikacji na środowisko produkcyjne
+
+## Elektronika naziemna (odbiornik)
+
+-   Odbieranie danych od komputera pokładowego (LORA)
+
+-   Przekazywanie danych do serwera za pomocą REST API
+
+-   Przekazywanie danych do kolejnych urządzeń za pomocą Seriala
+
+-   Konfiguracja/kontrola modułu:
+
+    -   zmiana parametrów uruchomieniowych
+
+# Lista wymagań niefunkcjonalnych
+
+## Komputer pokładowy
+
+-   Bezpieczny w użyciu
+
+-   Prosty w użyciu
+
+-   Niezawodny
+
+-   Dokładny
+
+-   Z czytelnym, przejrzystym kodem
+
+-   Technologie:
+
+    -   Arduino
+
+    -   C++
+
+    -   FreeRTOS
+
+## Nadajnik/Lokalizator
+
+-   Bezpieczna w użyciu
+
+-   Prosta w użyciu
+
+-   Niezawodny
+
+-   Dokładny
+
+-   Z czytelnym, przejrzystym kodem
+
+-   Technologie:
+
+    -   Arduino
+
+    -   C++
+
+    -   FreeRTOS
+
+## Elektronika naziemna (odbiornik)
+
+-   Bezpieczna w użyciu
+
+-   Prosta w użyciu
+
+-   Niezawodny
+
+-   Ładnie obudowana
+
+-   Z czytelnym, przejrzystym kodem
+
+-   Technologie:
+
+    -   Arduino
+
+    -   C++
+
+## Aplikacja internetowa (frontend)
+
+-   Wytworzona z użyciem nowoczesnych standardów
+
+-   Single Page Application
+
+-   Responsywna
+
+-   Intuicyjna w obsłudze
+
+-   Technologie:
+
+    -   Vue.js
+
+    -   Typescript
+
+## Aplikacja desktopowa
+
+-   Wytworzona z użyciem nowoczesnych standardów
+
+-   Single Page Application
+
+-   Responsywna
+
+-   Intuicyjna w obsłudze
+
+-   Zaprojektowana według najnowszych standardów .NET
+
+-   Używa nowych technologii i podejść programistycznych
+
+-   Z czytelnym i przejrzystym kodem
+
+-   Szybka obsługa zapytań
+
+-   Zintegrowana z elektroniką naziemną oraz pozostałymi modułami
+
+-   Technologie:
+
+    -   Vue.js
+
+    -   Electron
+
+    -   Typescript
+
+    -   .NET Core
+
+    -   C#
+
+## Aplikacja serwerowa - REST API
+
+-   Zaprojektowana według najnowszych standardów .NET
+
+-   Używa nowych technologii i podejść programistycznych
+
+-   Z czytelnym i przejrzystym kodem
+
+-   Szybka obsługa zapytań
+
+-   Technologie:
+
+    -   .Net Core
+
+    -   Docker
+
+## Baza danych
+
+-   Szybka obsługa zapytań
+
+-   Rozszerzalna
+
+-   Niezawodna
+
+-   Technologie:
+
+    -   NoSql
+
+## Prototyp aplikacji internetowej przetestowany przez użytkowników
+
+-   Technologie:
+
+    -   Adobe XD
+
+## Tablica projektowa - Trello
+
+-   Historia wymagań funkcjonalnych (User stories)
+
+-   Historia prac zdefiniowana zadaniami
+
+-   Lista wymagań funkcjonalnych zaplanowanych na przyszłość
+
+-   Lista zadań zaplanowanych na przyszłość
+
+## Repozytorium zawierające kod aplikacji, API oraz elektroniki
+
+-   Czytelne
+
+-   Uporządkowane
+
+-   Tworzone i utrzymywane ze sztuką
+
+-   Technologie:
+
+    -   GitHub
+
+# Mierzalne wskaźniki wdrożeniowe
+
+## Semestr I
+
+-   System zostanie przekazany w wersji testowej alpha.
+
+-   System zostanie zasilony danymi z symulacji lotu rakiet oraz danymi
+    historycznymi testów silników
+
+## Semestr II
+
+-   System zostanie udostępniony w domenie internetowej i będą z niego
+    korzystać członkowie koła (około 20 osób)
+
+-   Wizytówka koła będzie oglądana przez ludzi chcących się dowiedzieć
+    czegoś o kole.
+
+-   Przekazanie plików instalacyjnych do aplikacji desktopowej
+
+-   Na koniec drugiego semestru klient otrzyma system w wersji beta.
+
+# Kryteria akceptacji projektu dla I semestru prac
+
+## Wymagane
+
+-   Ukończenie zdefiniowanych funkcjonalności z listy wymagań
+    funkcjonalnych na pierwszy semestr
+
+-   Brak błędów utrudniających korzystanie z aplikacji
+
+-   Produkt został oddany w czasie
+
+## Oczekiwane
+
+-   Wykonanie produktu zgodnie z ustalonymi wymaganiami odnośnie
+    technologii
+
+## Planowane
+
+-   Zawieranie testów jednostkowych, integracyjnych, oraz czy spełniają
+    swoje zadanie
+
+# Kryteria akceptacji projektu dla II semestru prac
+
+## Wymagane
+
+-   Ukończenie zdefiniowanych funkcjonalności z listy wymagań
+    funkcjonalnych na drugi semestr
+
+-   Przetestowanie aplikacji pod kątem użytkowym przez testerów
+    (klientów końcowych)
+
+-   Brak błędów utrudniających korzystanie z aplikacji
+
+-   Produkt został oddany w czasie
+
+-   Produkt został wdrożony na domenę publiczną
+
+-   Produkt został przekazany klientowi
+
+## Oczekiwane
+
+-   Wykonanie produktu zgodnie z ustalonymi wymaganiami odnośnie
+    technologii
+
+## Planowane
+
+-   Zawieranie testów jednostkowych, integracyjnych, oraz czy spełniają
+    swoje zadanie
+
+# Organizacja pracy zespołu
+
+Strona zespołu projektowego:
+
+-   Wojciech Kubiak - Product Owner
+
+    -   Implementacja systemów wbudowanych
+
+    -   Zarządzanie dokumentacją
+
+    -   Komunikacja z klientem - czynny udział w kole
+
+-   Piotr Józefowicz - Scrum Master
+
+    -   Implementacja frontendu
+
+    -   Projektowanie prototypu interfejsu użytkownika
+
+-   Sebastian Wawrzyn - DevOps
+
+    -   Implementacja backendu aplikacji
+
+    -   Stworzenie bazy danych na potrzeby aplikacji API
+
+    -   Wdrożenie i dockeryzacja aplikacji
+
+Praca jest wykonywana w metodyce SCRUM w tygodniowych sprintach. Kod
+źródłowy trzymany jest na repozytorium na Githubie. Do podziału pracy i
+śledzenia progresu używamy aplikacji Trello
+
+# Ryzyka projektowe
+
+## Ryzyka ze względu na zasoby
+
+-   Odejście członka implementującego stronę serwerową - trudności w
+    ukończeniu aplikacji serwerowej
+
+-   Odejście członka implementującego stronę frontendową - trudności w
+    ukończeniu aplikacji
+
+-   Odejście członka implementującego systemy wbudowane - trudności w
+    ukończeniu aplikacji
+
+-   Określone ramy czasowe (semestry) na stworzenie produktu
+
+## Inne
+
+-   Nieporozumienia na linii zespół a klient wynikające z nieznajomości
+    pojęć domenowych lub nieporozumienia dotyczące funkcjonalności czy
+    innych rzeczy
+
+-   Nieporozumienia w zespole dotyczące rozwiązań implementacyjnych,
+    architektury, funkcjonalności lub używanych technologii
+
+-   Brak odpowiedniego zaangażowania w projekt ze strony zespołu,
+    wybranych członków zespołu
+
+-   Nagły brak wsparcia dla lub przerwanie rozwijania wykorzystywanej
+    technologii lub narzędzia - konieczność implementacji od nowa, lub
+    kontynuowanie implementacji w nieużywanym/źle zaprojektowanym
+    narzędziu, bibliotece
+
+-   Napięty termin, nakład obowiązków związanych z uczelnią oraz sprawy
+    prywatne, mogą negatywnie wpłynąć na pracę nad aplikacją
+
+-   Niestandardowy temat projektu, mogą pojawić się nieoczekiwane
+    trudności (rocket science)
+
+# Kamienie milowe
+
+-   I faza, I semestr (02.2020 - 07.2020):
+
+    -   Przygotowanie prototypu aplikacji
+
+    -   Przygotowanie backlogu dla projektu w systemie Trello,
+        opracowanie funkcjonalności, user stories
+
+    -   Rozpoczęcie prac programistycznych nad aplikacją
+
+    -   Rozpoczęcie prac programistycznych nad komputerem pokładowym 1.0
+
+    -   Testowanie komputera pokładowego
+
+    -   Ukończenie MVP aplikacji i komputera pokładowego
+
+    -   Poddanie MVP testom funkcjonalnym
+
+-   II faza, II semestr(10.2020 - 01.2021):
+
+    -   Uaktualnienie dokumentacji i Trello
+
+    -   Kontynuacja prac programistycznych nad aplikacjami
+
+    -   Kontynuacje prac programistycznych nad komputerem pokładowym
+
+    -   Rozpoczęcie prac nad nadajnikiem i odbiornikiem
+
+    -   Testowanie komputera pokładowego oraz elektroniki naziemnej
+
+    -   Ukończenie aplikacji wraz ze wszystkimi zdefiniowanymi
+        funkcjonalnościami
+
+    -   Integracja aplikacji z elektroniką
+
+    -   Testy integracyjne
+
+    -   Wdrożenie aplikacji na publiczną domenę

Przybylski/kompilator/Wizja.md

@@ -0,0 +1,153 @@
+# Project Vision Document
+
+#### Project name: MealyCompiler (Solomonoff)
+
+#### Authors: Aleksander Mendoza, Bogdan Bondar, Marcin Jabłoński
+
+#### Date: 13.12.2020
+
+### 1\. Executive summary 
+
+This project focuses on research in the field of automata theory and inductive inference. While many existing libraries already provide support for general purpose automata and implement various related algorithms, this project takes a slightly different approach. The primary tool for working with the library, is through domain specific language of regular expressions. Most of the things can be done without writing even a single line of Java code. We provide commandline as well as web interface and integrated build system. 
+
+The main applications concern formal methods, natural language processing, state-based system modeling, pattern recognition, inductive inference and machine learning. It can be of great help for researchers as well as can be used on industrial scale.
+
+The greatest competitor for Solomonoff is Google's OpenFST project. Solomonoff introduces dozens of improvements. The most important being efficiency improvements, symbolic ranges, nondeterminism detection and type system.
+
+### 2\. Goal and target audience
+
+The goal is to provide a better alternative for OpenFST. 
+
+OpenFst was a niche project with sparse documentation and neglected user interface. Everything is done primarily in C++ with templates, while commandline interface is basic, regular expression language has many fundamental flaws, their build system consists of tool for generating Makefiles that only call the compiler. Solomonoff strives to bring improvement with the following features: 
+
+- We have online REPL with examples and guides where everything works out of the box. Everything can be done with our rich and carefully designed regular expression language, so there is no need to write code. 
+
+- We provide extensive documentation in form of 3 scientific papers, detailed technical documentation of compiler implementation, extensive GitHub page and interactive REPL tutorial. 
+
+- We ship with integrated build system that supports parallelism and interacts with compiler directly for optimum performance. It can be configured in TOML build files. 
+
+- Everything can be done in regular expressions and there is no need to interact with compiler's API (althought we do provide as an addition).
+
+- There are plentiful of technical improvements, performance optimisations and innovative algorithms. All of them are described in detail in our documentation. We also provide performance benchamrks on our GitHub
+
+- Unlike any other existing automata tool, we ship with out-of-the functions for box inductive inference.
+
+
+The project found approval among members of Samsung's R&D team for Bixby developement and inductive inference researchers from Dortmund Technical University, Germany. Our system will be deployed in Samsung, our website can aid linguists with easily learning Solomonoff and our build system should make commandline usage more accessible.
+
+The main products are:
+
+- compiler backend - the core of the project
+- commandline interface with build system - allows more technical users to automate Solomonoff with shell scripts
+- website and REPl - allows less technical users to experiene Solomonoff without much friction.
+
+Our project brings performance, which was measured with benchmarks (available on GitGub). We provide innovation, which can be easily noticed by the sheer amount of features Solomonoff implements, which are not available in any other existing tool (more information in scientific papers). We are user-friendly and we assesed it during usability tests and by collecting feedback from end users. 
+
+### 3\. Market
+
+Currently there exists only one serious alternative, which is `OpenFST` library with their Thrax extension for writing regex-like grammars. Their solution has numerous problems. It's focus on probabilistic approach to modeling nondeterminism, made the library quite slow. It also became a double-edged sword, by making rule-based system difficult to maintain (compiler doesn't warn programmer when nondeterminism causes some rules to overshadow others). Compilation of grammars is lacking in many aspects. The grammar expression language is very basic and obscure. Compiler is not parallized and highly inefficient. On top of that, the probabilistic approach.
+
+- Our solution completely gets rid of nondeterminism. We will not attempt to model any probabilistic models. We will focus more heavily on making the expression language user-friendly and helpful in detecting potential non-determinism. The compiler should be able to process multiple rules in parallel to make compilation time faster. We implement Glushkov's construction and take advantage of special properties of functional transducers. For better user experience and easier management of code, we provide integrated build system and online REPL with extensive documentation.
+
+
+
+There used to be another similar project, developed by AT&T but it's been long discontinued and replaced by OpenFST. Aside from those two competitors, the market is very niche. There do not exist any other tools (or at least, they are not available publicly) strictly for compiling transducer. The closest other competitors might include general-purpose automata libraries like Google's `RE2` or  Anders Møller's `BRICS` library. However, those projects are fundamentally different as they implement classical automata instead of tranasducers. As a result, Solomonoff is strictly more powerful and superior to those solutions. There is no other automata compiler with support for inductive inference. There is no ther symbolic transducer library (although there exist general-purpose libraries for symbolic automata, like `symbolicautomata`, `Microsoft Automata Library`, `Rex`, `Bex`, `Fast`, `Mona`). 
+
+
+
+### 4\. Product description
+
+A simple and efficient library written in C will be the main and primary component of our product. On top of that, it will have command-line interface equipped with compiler. For easy and quick access, we should support online repl for all curious people who want to give our library a try. The compiler should support parallelism, warn user about non-determinism and allow for possibly some extent of generic programming (by defining functions working on regular expressions or bulk-generation of rules according to some regularities). We should ,however pay extra attention, to not making this language turing complete/undecidable by accident (otherwise compilation might never end).
+
+- simple and efficient compiler-backend written in Java
+  - regular expression (concatenation, Kleene closure, union, composition, projection, inverse, composition, difference)
+  - algorithms of inductive inference
+  - type system
+  - integration with LearnLib
+  - is optimised for functional ranged transducers (symbolic automata)
+
+- REPL and build system
+    - support for parallelism
+    - non-determinism warnings
+    - packaging system
+    - dependency resolver
+    - supports everything that compiler does
+    - additional directives
+    - TOML configurations
+
+- online repl and interactive tutorial
+    - can write regular expressions on-the-fly
+    - has all functions of the compiler
+    - saves work of user (cookies and session)
+    - syntax highlighting
+    - user can download the effects of their work for their local computer
+    - visualizes graphs of automata
+    - provides technical documentation
+
+Project architecture and key components:
+
+  - there is all theoretical work and background written in our PDF
+  - theoretical paper serves as basis for formal specification of library functions
+  - Java compiler uses as few libraries as possible: ANTLR for parsing, LearnLib for inductive inference
+  - REPL is developed on top of compiler backend and is not included in the compiler itself (although compiler provides certain facilities necessary for implementing REPL)
+  - build system is developed and shipped independently from compiler backend
+  - online REPL with backend in Spring, uses compiler's Java API.
+  - the REPL used by build system and web brwoser has overlaping features but due to inherent differences between the two enviroments their implementations differ a little.
+  - website contains documentation, examples and tutorials
+
+Our target audiences include:
+
+- researchers who want to:
+  - have some ready-made library with functionalities they need for experiments.
+  - verify formal properties of complex sequential systems
+- linguists
+  - working on rule-based translation
+- machine-learning experts
+  - who work in fields related to natural language processing
+who use Solomonoff inference
+  - Companies developing artifical inteligence systems
+who might use it as one of their tools. (Especially if their employees are any of the people above)
+
+
+### 5\. Scope and limitations
+
+
+Work schedule: 
+
+- first semester
+  - formal specification
+  - C library prototype (unoptimised)
+  - compiler prototype
+  - online repl prototype (with dummy compiler functionality)
+- second semester
+  - optimised Java compiler
+  - compiler usable in practice and tested on real life users
+  - online repl integrated with compiler
+  - machine learning algorithms
+  - build system
+
+Team:
+
+- Aleksander Mendoza
+  - formal specification and theoretical foundations
+  - compiler implementation (Java)
+  - unit tests (JUnit)
+- Bogdan Bondar
+  - web design (Bootstrap)
+  - backend development (Spring)
+  - integration tests (Selenium)
+- Marcin Jabłoński
+  - build system (Java)
+  - REPL (ANTLR)
+  - assisting with compiler implementation (initial but discontinued C version)
+
+Limitations:
+
+- no official support for mobile devices. Website is responsive but no mobile-optimised version was added. End users should not code on their smartphones, which is not a common practice either way.
+- no/limited compiler backend for embedded devices. While JavaME does exist, the compiler was not meant to be deployed in embedded systems.
+- no (centralised) package manager for build-system. Developing package manager infrastructure is a prohibitively expensive operation.
+
+
+
+
+

Przybylski/kompilator/wymagania projektowe.md

@@ -0,0 +1,254 @@
+# Project Requirements Document
+
+### Project name: MealyCompiler (Solomonoff)
+
+### Authors: Aleksander Mendoza, Bogdan Bondar, Marcin Jabłoński
+
+### Date: 8.01.2021
+
+#### 0\. Document version
+
+- 13.12.2020 - initial version
+- 8.01.2021 - minor improvements and final touch
+
+#### 1\. Project's components (project's products)
+
+
+Done in first semester:
+
+- C compiler backend (discontinued, because requirements shifted more towards Java)
+	- regular expression (concatenation, Kleene closure, union, output)
+	
+- Java prototype
+	- regular expression (concatenation, Kleene closure, union
+	- type system
+
+- Online REPL prototype
+   - runs C backend in WebAssembly
+   - Ace editor with syntax highlighting
+
+Second semester:
+
+
+- simple and efficient compiler-backend written in Java
+  - regular expression (concatenation, Kleene closure, union, output, composition, projection, inverse, composition, difference)
+  - algorithms of inductive inference
+  - type system
+  - integration with LearnLib
+  - is optimised for functional ranged transducers (symbolic automata)
+  - parser in ANTLR
+
+
+- REPL and build system
+    - support for parallelism
+    - non-determinism warnings
+    - packaging system
+    - dependency resolver
+    - supports everything that compiler does
+    - additional directives 
+    - TOML configurations
+
+- online repl and interactive tutorial
+    - can write regular expressions on-the-fly and has all functions of the compiler (REST calls to Spring backend, which calls compiler Java API)
+    - saves work of user (cookies and session)
+    - syntax highlighting (Ace editr)
+    - user can download the effects of their work for their local computer
+    - visualizes graphs of automata (uses viz.js)
+    - provides technical documentation (formulas with MathJax)
+- tests
+	- integration tests in Python with Selenium (Firefox + Chrome)
+	- all invariants, precodnitions, postconditions of specification expressed in form of assertions. Runtime analysis of specification with JUnit. 
+	- automatically generated tests for random automata 
+	- performance benchmarks
+	- usability tests
+- theory and specification
+    - scientific papers explaining the theory with appropriate mathematical rigour
+    - papers with proofs of correctness of essential algorithms
+
+#### 2\. Project limitations
+
+- The minimal required Java version 1.8 . Oracle has dropped support for older versions long ago
+- Website makes minimal use of CSS3, but older browsers should still be able to use the website. 
+- Internet explorer is not supported, because Microsoft stopped developing it.
+- We did not test website for Safari and Edge, but they should work as well.
+- build system and commandline interface works on all systems that can run Java. Embedded devices are not supported, as such a use case is unlikely. In the future we might add lightweight runtime that can execute automata on embedded envronments.
+
+Justifications:
+
+- initially we started writing compiler in C for best performance. Over the course of development it turned out that performance gains were minimal compared to Java, while the speed writing C code was much slower compared to ease of higher level development in Java. Moreover, the Samsung infrastructure heavily relies on Java and we found out that Java libraries are always preferred over C. Later we also established cooperation with LearnLib from Dortmund university and their entire library is written purely in Java. Hence we decided to switch to Java for better compatibility.
+- we decided to make a website, because this technology is universaly accessible to everyone. A mobile app would require installation (and touch screen would be uncomfortable for writing regexes), command-line interface is only accessible to advanced users and desktop GUI apps require downloading, installation and setup. An online REPL would make Solomonoff easily accessible to masses.
+- The build system was implemented in Java for compatibility with compiler backend. It is primarly targeted at more advanced users and large projects. Build system allows for working with multiple files, which extends the compiler backend that is only capable of working with monolithic streams of code.
+- We considered using user authorization but we decided to keep it simple. Cookies and downloads are out only mean of permanent storage. Hiding our REPL behind "login wall" could potentially turn away some impatient users. There are many demo websites similar to ours that follow similar strategy and don't retain any user data.
+- There are plenty of compiler features that we purposely did not implement. We do not support probabilistic automata, because their semantics tend to be unpredictable and difficult to control by regexes. We don't allow epsilon transitions and it allows for many optimisations. More such examples and technical details can be found in our documentation.
+- Build system does not support namespaces. Instead we took approach similar to C, where "modules" are not a first-class language feature and are instead based on naming convention. When it comes to language features we are strong believers that simplicity and follow the mantra of "less means more". 
+
+
+#### 3\. List of functional requirements 
+
+- Java API:
+   - load/save transducer from/to file
+   - compile reguler expression
+   - run transducer
+   - create multiple independent instances of compiler that can work in parallel
+- Build system
+   - load one or more files
+   - use transducers defined in other files
+   - compile files in project in parallel
+   - define list of source files in build configuration
+   - store many independent configuration files, even in the same directory
+   - run REPL after building project
+- Online REPL
+   - open website and follow tutorial (shows additional tips for first time)
+   - compile a larger piece of code and then experiment with it in REPL
+   - compile code line by line in REPL
+   - read the technical documentation
+   - reopen website and continue where you left off (depending on time limit some things might be lost. The server should not store compiler instances indefinitely)  
+   - download work progress locally
+   - go to GitHub page/download compiler and build system JAR
+- Language functionalities:
+   - union, concatenation, kleene closure, output, composition, difference, inversion, identity, clear output
+   - inference: RPNI, RPNI-EDSM, RPNI-MEALY, OSTIA
+   - weights, reflections, functional nondeterminism
+   - ambiguous nondeterminism detection, typechecking
+   - lazy composition, linear programs, hoare-triples
+   - external native functions, optional user extensions
+
+
+#### 4\. List of non-functional requirements
+
+- scientific papers describing the theory in detail
+- end user tests
+- integration in Samsung
+- integration with LearnLib
+- performance benchmarks
+- accessible and easy tutorials even for less technical users like linguists
+
+
+#### 5\. Measurable indicators 
+
+- efficiency benchmarks on large datasets of regular expressions
+	- RAM usage
+	- disk usage 
+	- execution speed
+	- compilation speed
+- list of features
+- contributions to LearnLib
+- deployment on http://solomonoff.projektstudencki.pl/
+- unit tests
+- integration tests
+- user experience feedback
+
+
+#### 6\. Acceptation criteria for first semester 
+
+- required:
+	- C compiler implementation:
+	   - union, 
+	   - concatenation, 
+	   - kleene closure
+	   - output
+	   - execution
+	- Java prototype, theory and specification
+	   - Glushkov's construction with variables
+	   - type system
+	   - nondeterminism detection
+	   - binary search execution
+	- online compiler 
+		- WebAssembly bindings
+		- Ace editor and syntax highlighting
+		- website design
+- expected:
+	- usable precompiled delivery
+	- optimised algorithms
+	- additional operations (composition, inverse, subtraction)
+- planned:
+	- support for formal verification
+	- inductive inference
+	- optimisations
+	- fully developed compiler
+	- tutorials, examples, how-tos
+	- extensive testing
+
+#### 7\. Acceptation criteria for second semester 
+
+- required:
+   - fully usable optimised compiler with all additional features
+   - working with multiple source files
+   - inductive inference
+   - tutorials, examples how-tos
+   - compatibility with client's existing Java infrastructure
+   - compatibility with LearnLib
+- expected:
+   - secondary compiler features (graph visualisation, export/import, external utility functions)
+   - parallel compilation
+   - configurable build system
+   - inductive inference artifacts as build dependencies
+   - scripts for automated integration tests
+   - great performance benchmarks
+   - detailed technical documentation
+- planned:
+   - partial inductive inference (OSTIA-C) for LearnLib
+   - Thrax-Solomonoff converter for backward-compatibility with legacy systems
+   - Video tutorials
+   - advanced online code editor/full online IDE
+   - extensible build system with plugins and repositories
+
+#### 8\. Project work organization
+
+- Aleksander Mendoza (Product owner)
+  - Glushkov's construction 
+  - weighted transducers
+  - inductive inference
+  - nondeterministic minimization
+  - 
+- Bogdan Bondar (implementation)
+  - Spring backend
+  - frontend
+  - compiler integration
+  - testing (Selenium, unittest, JUnit)
+- Marcin Jabłoński (implementation)
+  - build system (Java)
+  - repl 
+  - dependency resolver 
+  - compiler developemnt (assistance and C implementation)
+  - compiler extension for handling multi-file projects
+
+Aleksander Mendoza is responsible for finding clients and communicating with them. 
+
+Initially our team attempted to use Scrum, but later we switched to incremental methodology, because workflow relied heavily on specification and long-term planning. Scrum's main advantage lies in its flexibility, which wasn't the key for this project. It also imposed unrealistic and unnatural team dynamics, which only made work more complicated than it had to be. Scrum gives all team memebrs high degree of independence and autonomy. In scrumchat, implementators describe the progress they made. On the other hand, in our project the specification is more rigid and work progresses according to it. Hence, it's always well understood who does what at which moment. The future tasks are generally known ahead of time.
+
+Tools:
+
+- JIRA
+- git & GitHub
+- CircleCI
+- Selenium for integration tests
+- MS Teams for video chats, Messanger for daily quick chat
+
+We created a full detailed list of planned tasks at the beginning of semester and tried to follow it, but we also added more unforseen tasks on the rolling basis according to necessity.
+Every task corresponded to some palpable feature and its implementation allowed for closing the task.
+
+#### 9\. Project risks
+
+- The most important risk of our project was its heavy reliance on advanced theoretical concepts. It required plenty of rigour to make sure our foundations are correct and well defined. Should anything in our understanding of automata be wrong, the whole project would at risk of becoming irrelevant. 
+
+- The second most critical concern was time. There was plenty to do and very little time. It was haard to estimate how much any of the tasks would take. While missing initial deadlines due to unforseen complications is typical for software engineering projects, our project was exposed to a such risks at a much larger scale. Should anything be wrong in the formal specification, it could require months of additional research. In the worst case, if there was a mistake, some goals might turn out to be mathematically impossible. For this reason our team had to be rigorous about their promises.
+
+- The organization of work was a challenge. Project requirements often required us to learn new technologies and solve nontrivial problems. Our team often got stuck on challenging problems and sometimes we had to change plans as some of our plans turned out to be technically impossible:
+    - we struggled with JWebAssembly and in the end switched to Spring
+    - the low-level C implementation was going too slow and we faced the risk of not delivering on time
+    - after the first semester we gained plenty of experience developing Java prototype and we noticed a galore of details that could be done better than we initially planned. We took a drastic decision to rewrite the compiler in Java, which was seen as risky.
+
+  Due to these and many other difficulties, our team could have failed on multiple occations.
+
+- Our project is very niche and finding clients is not easy. If any of our clients lost interest in our solution, finding a new one might become impossible.
+
+#### 10\. Milestones
+
+- proof of concept and first implementation of Glushkov's construction (Deadline: end of first semester)
+- proof of concept for type system (Deadline: end of first semester)
+- establishing relations with Dortmund University 
+- preparing code for adoption in Samsung. It requires writing a very specific feature that allows for converting legacy codebase from Thrax to Solomonoff. (Deadline: end of 2020)
+- getting build system ready (Deadline: end of 2020)
+- testing (Deadline: end of January 2021)
+- full integration in Samsung (Deadline: February 2021)

Przybylski/sprawdziany/wizja-projektu.md

@@ -0,0 +1,197 @@
+**Dokument wizji projektu**
+
+**Nazwa projektu:**\
+**\"Platforma do generowania i publikacji sprawdzianów z matematyki --
+Gen-Mat\"**
+
+**Autorzy:**
+
+**Damian Kuich**
+
+**Mikołaj Kowalczyk**\
+**Łukasz Adam Kubiak**\
+**Mateusz Michalski**
+
+**Data: 31.10.2020**
+
+**1. Executive summary.**
+
+Projekt "Gen-Mat" jest to nowy serwis do generowania i publikacji
+sprawdzianów z matematyki na poziomie szkół ponadpodstawowych. Generator
+ma za zadanie znacznie uprościć proces tworzenia sprawdzianów, dzięki
+czemu użytkownik zaoszczędzi cenny czas. Zakładamy też, że możliwość
+generowania unikalnych sprawdzianów pozwoli na zmniejszenie procentu
+uczniów wymieniających się odpowiedziami do zadań. Skutkiem czego będzie
+bardziej sumienne przygotowywanie się do testów sprawdzających wiedzę i
+umiejętności z matematyki.
+
+**2. Cel i grupa docelowa.**
+
+Celem projektu jest zaoszczędzenie czasu potrzebnego na własnoręczne
+tworzenie sprawdzianów z matematyki. Rozwiązaniem tego problemu będzie
+serwis pozwalający na automatyczne generowanie takich sprawdzianów
+korzystając z gotowej i sprawdzonej bazy zadań. "Gen-Mat" jest
+skierowany głównie dla nauczycieli szkół ponadpodstawowych, ponieważ w
+aktualnej swej formie baza będzie zawierać tylko zadania z matur za
+zgodą uzyskaną od CKE. Dotarcie do grup docelowych umożliwią nam np.
+Grupy dla nauczycieli z matematyki na platformie Facebook albo
+komunikacja ze zaznajomionymi szkołami ponadpodstawowymi. Głównym
+produktem naszego projektu będzie aplikacja webowa, ponieważ jest to
+temat w którym każdy z członków zespołu jest zaznajomiony.
+
+**3. Rynek (min. 3 konkurencyjne produkty).**
+
+W fazie rozwoju platforma będzie darmowym serwisem. Gdy serwis zostanie
+doprowadzony do pełnej funkcjonalności przewidywana jest płatna
+subskrypcja, a dla studentów uczących się na uczelniach, gdzie nasz
+produkt będzie wykorzystywany, dostęp do niego będzie darmowy. Wiele
+generatorów testów i sprawdzianów z matematyki (np. klasowki.pl,
+kompozytorklasowek.gwo.pl, dlanauczyciela.pl/generator) jest do siebie
+podobnych. Naszym zadaniem jest stworzyć system spełniający oczekiwania
+klientów. Zawierałby ulepszone funkcjonalności konkurencyjnych serwisów
+i dodawał nowe, które ułatwiłyby pracę z naszym serwisem i rozszerzyły
+jego możliwości. Generator w odróżnieniu od istniejących serwisów
+umożliwiających generowanie sprawdzianów z matematyki może na podstawie
+wygenerowanych wcześniej sprawdzianów utworzyć sprawdzian poprawkowy a
+także wygenerować powtórkę przed sprawdzianem, zawierającą część
+praktyczną jak i teoretyczną, gdzie zadanie może zawierać podpowiedzi
+np. potrzebne wzory lub sposób rozwiązania.
+
+**4. Opis produktu (min. 3 moduły/epiki)**
+
+-   Panel Administratora :
+
+    -   Obszar: zarządzanie danymi, kontrola danych.
+
+    -   Rodzaj: Administrator
+
+-   Generator Sprawdzianów:
+
+    -   Obszar: przetwarzanie danych
+
+    -   Rodzaj: autoryzowany użytkownik
+
+-   Panel Rejestracji:
+
+    -   Obszar: przetwarzanie danych, autoryzacja
+
+    -   Rodzaj: użytkownik o ograniczonych prawach
+
+-   Panel Logowania:
+
+    -   Obszar: przetwarzanie danych, autoryzacja
+
+    -   Rodzaj: autoryzowany uzytkownik
+
+**5. Zakres i ograniczenia.**
+
+**5.1 Skład zespołu:**
+
+Damian Kuich(Backend) - odpowiedzialny za wdrożenie RESTful API do
+projektu i deploy aplikacji na serwer. Zajmuje się także wprowadzaniem
+zadań do bazy. Preferowane technologie: Python
+
+Mikołaj Kowalczyk(Backend) - odpowiedzialny za utworzenie bazy danych i
+pomoc przy tworzeniu API. Zajmujesię także wprowadzaniem zadań do bazy.
+Preferowane technologie: Python
+
+Łukasz Kubiak(Frontend)- odpowiedzialny za funkcjonalność Frontend'u i
+odbierania endpointów od Backend'u. Pomaga przy tworzeniu UI projektu.
+Preferowane technologie: JavaScript
+
+Mateusz Michalski(Frontend) - odpowiedzialny za tworzenie UI projektu.
+Pomaga przy funkcjonalnościach. Preferowane technologie: JavaScript
+
+**5.2 Kamienie milowe:**
+
+-   **I faza, I semestr(02.2020 - 07.2020):**
+
+    -   Przygotowanie backlogu serwisu
+
+    -   Przygotowanie prototypu interfejsu
+
+    -   Rozpoczęcie prac programistycznych
+
+    -   Przygotowanie MVP serwisu
+
+    -   Poddanie MVP testom funkcjonalnym
+
+-   **II faza, II semestr(10.2020 - 03.2021):**
+
+    -   Przygotowanie sprintów na drugi semestr
+
+    -   Ukończenie prac wraz ze wszystkimi zdefiniowanymi
+        funkcjonalnościami
+
+    -   Publikacja serwisu na domenie publicznej i włączenie jej na
+        serwer
+
+
+**5.3 Szkic Harmonogramu:**
+
+**Semestr I:**
+
+-   Utworzenie konta użytkownika (logowanie i rejestracja)
+
+-   Utworzenie bazy danych z zadaniami
+
+-   Edycja konta użytkownika
+
+-   Resetowanie hasła
+
+-   Dodanie możliwości wyboru działów i umiejętności
+
+-   Wyszukiwarka zadań
+
+-   Ręczne tworzenie sprawdzianu
+
+-   Podział na grupy(Dla ręcznego tworzenia)
+
+-   Możliwość dodania obrazka
+
+-   Prototyp generatora(Wybór: trudności zadań i ich ilości, działów i
+    umiejętności)
+
+-   Generowanie karty odpowiedzi i klucza odpowiedzi
+
+-   Eksport sprawdzianu do PDF
+
+**Semestr II:**
+
+-   Edycja wygenerowanego sprawdzianu
+
+-   Dodawanie obrazka do zadania(jpg,png)
+
+-   Miejsce pod zadaniem
+
+-   Dodawanie własnych zadań
+
+-   Edycja dodanych zadań
+
+-   Ustawienie zadań na prywatne/publiczne
+
+-   Możliwość udostępniania swoich zadań innym nauczycielom
+
+-   Możliwość oszacowania czasu na rozwiązanie zadania
+
+-   Edytor równań
+
+-   Postawienie strony na serwerze
+
+-   Dodanie publicznej domeny
+
+**5.4 Ograniczenia:**
+
+W pierwszej fazie projektu, produkt oferować będzie ograniczoną ilość
+działów, co za tym idzie ograniczoną ilość umiejętności potrzebnych do
+rozwiązania zadania i zadań z powodu praw autorskich. Możliwa będzie
+edycja wyłącznie zadań dodanych przez użytkowników (jeżeli autor zadania
+wyrazi na to zgodę). Do tej pory udało nam się otrzymać pozwolenie od
+CKE na korzystanie z ich zadań, jednakże pod dwoma warunkami: brak
+możliwości edycji zadań oraz obowiązkowe podanie autora zadania wraz z
+zasadami oceniania. Możliwy będzie wybór trudności zadań wraz z ich
+liczbą, podział na grupy (maks. 4), edytowanie i eksport sprawdzianu do
+pdf, ustalenie punktacji do zadań, możliwość stworzenia własnego
+sprawdzianu. Będzie możliwość stworzenia konta użytkownika i jego edycji
+ale nie będzie posiadał możliwości uwierzytelniania czy osoba jest
+uprawniona do używania serwisu.

Przybylski/sprawdziany/wymagania-projektowe.md

@@ -0,0 +1,305 @@
+**Dokument wymagań projektowych**
+
+**Nazwa projektu:**\
+**\"Platforma do generowania i publikacji sprawdzianów z matematyki --
+Gen-Mat\"**
+
+**Autorzy:**
+
+**Damian Kuich**
+**Mikołaj Kowalczyk**\
+**Łukasz Adam Kubiak**\
+**Mateusz Michalski**
+
+**Data: 31.10.2020**
+
+**1. Wersja dokumentu**
+
+**1. Elementy składowe projektu (produkty projektu)**
+
+**Semestr I:**
+
+-   Instancja serwera bazy danych oparta o silnik MySQL.
+
+-   Business Model Canvas.
+
+-   Value Proposition Canvas.
+
+-   Dokument Wizji Projektu.
+
+-   Prezentacja projektu.
+
+-   Harmonogram prac.
+
+-   Prototyp UI wykonany z użyciem Adobe XD.
+
+-   Arkusz z wynikami testów UI.
+
+-   Zakres Projektu.
+
+-   Dokumentacja Techniczna.
+
+-   Repozytorium Git.
+
+-   Strona projektowa na Jira.
+
+**Semestr II:**
+
+-   Instancja serwerowa oparta o Heroku.
+
+-   Prezentacja prac na 2 semestr
+
+-   Aplikacja webowa w języku Python oparta o framework Django.
+
+-   Pomocnicza aplikacja webowa w Node JS
+
+**2. Granice projektu**
+
+Projekt jest tworzony jako serwis webowy, ponieważ większość nauczycieli
+swoją pracę spędza przy komputerach. Przy tworzeniu sprawdzianu mniejszy
+ekran(np. Telefon, tablet) byłby ogromnym minusem przy tego typu
+aplikacji. Serwis, też będzie posiadał ograniczoną bazę danych
+posiadającą tylko zadania z CKE, ponieważ korzystanie z innych źródeł
+jest narażone na opłatę praw do użytku. Kolejnym problemem jest obsługa
+ogromnej ilości użytkowników na raz co przy aktualnym serwerze jest
+niemożliwe bez własnego wkładu finansowego. Aplikacja też nie posiada
+funkcjonalności autoryzacji, czy podana osoba jest nauczycielem. Taka
+funkcjonalność byłaby bardzo ciężka do wdrożenia, ponieważ
+potrzebowałaby bardzo dobrych zabezpieczeń i bardzo dobrego pomysłu na