|
|
|
# Dokumentista
|
|
|
|
|
|
|
|
Tämä dokumentti on "elävä"-dokumentti, joka päivittyy jatkuvasti. Se on nykymuodossaan vain karkea runko, jota "voi" käyttää projektien teknisen dokumentoinnin pohjana. Rakennetta saa ja pitää muokata! Tavoitteena on luoda dokumentti, joka yhdistää suunnitteludokumentaation saumattomasti yhteen projektin muun dokumentaation kanssa. Tekijä ei ota mitään vastuuta dokumentin sisällöstä.
|
|
|
|
|
|
|
|
tv:NarsuMan
|
|
|
|
Tämä dokumentti on "elävä"-dokumentti, joka päivittyy jatkuvasti.
|
|
|
|
|
|
|
|
## Otsikko
|
|
|
|
|
|
|
|
v0.01
|
|
|
|
v0.9
|
|
|
|
|
|
|
|
Luokittelu Julkinen
|
|
|
|
|
|
|
|
Petri Penttinen
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Jusa Myrskog
|
|
|
|
|
|
|
|
|
|
|
|
## Johdatus
|
|
|
|
|
|
|
|
* Johdatus dokumenttiin..
|
|
|
|
|
|
|
|
|
|
|
|
* Tässä dokumentissa käydään läpi teknologioita ja kirjastoja, joita projektin tuotoksen tekemisessä käytetään. Käytetyt teknologiat ja kirjastot voivat vielä muuttua projektin aikana, jos törmätään odottamattomiin ongelmiin toteutuksen kanssa.
|
|
|
|
|
|
|
|
|
|
|
|
## Yleiskuvaus
|
|
|
|
|
|
|
|
* OBSIMO-Opintosuunnittelu työkalu on tehty toimimaan yhdessä opintosuunnitelman kanssa helpottamaan valintoja ja antamaan suuntaa-antavia opintoja mitä tarvitaan työelämässä.
|
|
|
|
* Dokumentin tehtävä on avata esim. jatkokehittäjälle käsitys siitä miten tuote on toteutettu (Pelkkä lähdekoodi ei riitä)
|
|
|
|
* Tietokoneen, Gitlab, Fluid-id, draw-io.
|
|
|
|
|
|
|
|
* OBSIMO-Opintosuunnittelun työkalu on tehty toimimaan yhdessä opintosuunnitelman kanssa helpottamaan valintoja ja antamaan järkeviä, yrityksiltä saatuja ehdotuksia opintojen valinnassa.
|
|
|
|
* Dokumentin tehtävä on avata esim. jatkokehittäjälle käsitys siitä miten tuote on toteutettu.
|
|
|
|
|
|
|
|
## Käytetyt teknologiat
|
|
|
|
|
|
|
|
* MySQL - Hyvä tietokanta
|
|
|
|
* MySQL/MariaDB - Hyvä tietokanta
|
|
|
|
* HTML - Käytetty nettisivuihin
|
|
|
|
* PHP - Hyvä serveripuoli
|
|
|
|
* React - Käyttöliittymän tekemiseen
|
|
|
|
* Jquery - Käyttöliittymään
|
|
|
|
* CSS - Käyttöliittymän muotoilu
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Tuotekehitysympäristöjen kuvaukset
|
|
|
|
|
|
|
|
Kuvaa ainakin seuraavat:
|
|
|
|
|
|
|
|
* Kehitysympäristö - DeepOcean / Virtuaalikone
|
|
|
|
* Testausympäristö - DeepOcean / Virtuaalikone / Gitlab
|
|
|
|
* Ajo/suoritusympäristö - DeepOcean / Virtuaalikone
|
| ... | ... | @@ -54,25 +42,23 @@ Eli miten nuo eri ympäristöt on toteutettu ko. projektissa |
|
|
|
|
|
|
|
## Käytetyt työvälineet ja niiden versionumerot
|
|
|
|
|
|
|
|
* Kääntäjä xyz v1.0.1
|
|
|
|
* debuggeri zky v2.05
|
|
|
|
* Firefox 123
|
|
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
|
|
|
|
* MariaDB 10.2.13
|
|
|
|
* PHP 7.2
|
|
|
|
* PHP PDO
|
|
|
|
* React v16.0
|
|
|
|
* React Router v4
|
|
|
|
* Jquery 3.3.1
|
|
|
|
|
|
|
|
## Tärkeimmät tekniset ratkaisut joihin tuote nojaa
|
|
|
|
|
|
|
|
|
|
|
|
* Käytetyt kirjastot(library)/kehikot(Framework) (JQuery v 23456, JAVA EE 8 + Spring ZZZ, React IO)
|
|
|
|
* Muut jipot ja kikat
|
|
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
* React v.16.0
|
|
|
|
* React Router v4
|
|
|
|
* PHP
|
|
|
|
* PHP PDO
|
|
|
|
|
|
|
|
## Yleinen ohjelmiston arkkitehtuuri
|
|
|
|
|
|
|
|
*
|
|
|
|
* Palvelut
|
|
|
|
* 
|
|
|
|
|
|
|
|
|
|
|
|
## Palvelujen/n rajapinnat (Interfaces)
|
| ... | ... | @@ -81,21 +67,9 @@ Eli miten nuo eri ympäristöt on toteutettu ko. projektissa |
|
|
|
|
|
|
|
## Suoritysympäristön (tuotanto) kuvaus
|
|
|
|
|
|
|
|
* Miten tuote ajetaan tuotannossa
|
|
|
|
* Sijoittelunäkymä (Depoyment diagram)
|
|
|
|
|
|
|
|
* Tuote laitetaan tarjottavaksi DeepOcean -virtuaalikoneelle.
|
|
|
|
|
|
|
|
## Tietokantakuvaukset
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ER-kaavio
|
|
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TBD |
