|
|
|
## Tekninen dokumentaatio
|
|
|
|
|
|
|
|
Versio: 0.1
|
|
|
|
|
|
|
|
Luokittelu: Julkinen
|
|
|
|
|
|
|
|
Vastuuhenkilö: CTO Valtteri Puonti
|
|
|
|
|
|
|
|
## Johdatus
|
|
|
|
|
|
|
|
Tässä jatkuvasti päivittyvässä dokumentissa on listattu projektiin käytetyt tekniikat ja syyt miksi niitä käytetään.
|
|
|
|
|
|
|
|
## Tuotteen kuvaus
|
|
|
|
|
|
|
|
Tuote on sovellus joka tarjoaa käyttöliittymän datan visualisoimiselle (opiskelijan kurssinäkymä) ja datan muokkaamiselle (kysely). Tuote on kuvattu tarkemmin Vaatimusmäärittelyssä.
|
|
|
|
Tuote toimii selainympäristössä, backend pilvessä. Dataa pitää renderöidä ja muuttaa DOM:issa, joten JavaScript + React on käypä valinta front-endiin. Backend ratkaisut ovat vielä epäselviä, mutta dokumentti päivittyy kun saamme sen selville.
|
|
|
|
|
|
|
|
## Käytetyt teknologiat
|
|
|
|
|
|
|
|
* JavaScript, koska käytämme selainta
|
|
|
|
* React, koska DOM:ia pitää päivittää
|
|
|
|
|
|
|
|
|
|
|
|
## Tuotekehitysympäristöjen kuvaukset
|
|
|
|
|
|
|
|
Kuvaa ainakin seuraavat:
|
|
|
|
|
|
|
|
Frontend kehitysympäristöinä toimii Netbeans, VisualStudio Code, Brackets.
|
|
|
|
Testausympäristö on ---------
|
|
|
|
Ajo/suoritusympäristö on -------
|
|
|
|
Demoympäristö on -------
|
|
|
|
|
|
|
|
## Käytetyt työvälineet ja niiden versionumerot
|
|
|
|
|
|
|
|
TBA
|
|
|
|
|
|
|
|
* Kääntäjä xyz v1.0.1
|
|
|
|
* debuggeri zky v2.05
|
|
|
|
* Firefox 123
|
|
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
|
|
|
|
## Tärkeimmät tekniset ratkaisut joihin tuote nojaa
|
|
|
|
|
|
|
|
TBA
|
|
|
|
|
|
|
|
* Käytetyt kirjastot(library)/kehikot(Framework) (JQuery v 23456, JAVA EE 8 + Spring ZZZ, React IO)
|
|
|
|
* Muut jipot ja kikat
|
|
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
|
|
|
|
## Yleinen ohjelmsto arkkitehtuuri
|
|
|
|
|
|
|
|
*
|
|
|
|
* Palvelut
|
|
|
|
|
|
|
|
|
|
|
|
## Palvelujen/n rajapinnat (Interfaces)
|
|
|
|
|
|
|
|
* [Esimerkki elävästä elämästä](https://virkailija.opintopolku.fi/koodisto-service/swagger/index.html)
|
|
|
|
|
|
|
|
## Suoritysympäristön (tuotanto) kuvaus
|
|
|
|
|
|
|
|
* Miten tuote ajetaan tuotannossa
|
|
|
|
* Sijoittelunäkymä (Depoyment diagram)
|
|
|
|
|
|
|
|
|
|
|
|
## Tietokantakuvaukset
|
|
|
|
|
|
|
|
|
|
|
|
ER-kaavio
|
|
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TBD |