|
|
## Tekninen dokumentaatio
|
|
# Tekninen arkkitehtuuri
|
|
|
|
|
|
|
|
Versio: 0.1
|
|
Versionumero 1.0
|
|
|
|
|
|
|
|
Luokittelu: Julkinen
|
|
Luokittelu: Julkinen
|
|
|
|
|
|
|
|
Vastuuhenkilö: CTO Valtteri Puonti
|
|
Vastuuhenkilö
|
|
|
|
|
|
|
|
## Johdatus
|
|
## Johdatus
|
|
|
|
|
|
|
|
Tässä jatkuvasti päivittyvässä dokumentissa on listattu projektiin käytetyt tekniikat ja syyt miksi niitä käytetään.
|
|
Tässä jatkuvasti päivittyvässä dokumentissa on listattu projektiin käytetyt tekniikat ja syyt miksi niitä käytetään.
|
|
|
|
|
|
|
|
## Tuotteen kuvaus
|
|
## Yleiskuvaus
|
|
|
|
|
|
|
|
OBSIMO -opetussuunnittelujärjestelmä tarjoaa helpotusta opiskelijoiden henkilökohtaisen opintosuunnitelman luomiseen. Palvelun avulla myös yritykset voivat esittää, mitä pitäisi opiskella päästäkseen heille töihin. 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 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.
|
|
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
|
|
## Käytetyt teknologiat
|
|
|
|
|
|
|
|
* JavaScript, koska käytämme selainta
|
|
* JavaScript, koska käytämme selainta
|
|
|
* React, koska DOM:ia pitää päivittää
|
|
* React, koska DOM:ia pitää päivittää
|
|
|
|
* DigitalOcean (cloud service)
|
|
|
|
* MongoDB
|
|
|
|
|
|
|
|
### [Ominaisuus: Kysely](Ominaisuus-Kysely)
|
|
### [Ominaisuus: Kysely](Ominaisuus-Kysely)
|
|
|
|
|
|
| ... | @@ -29,59 +32,44 @@ Tuote toimii selainympäristössä, backend pilvessä. Dataa pitää renderöid |
... | @@ -29,59 +32,44 @@ Tuote toimii selainympäristössä, backend pilvessä. Dataa pitää renderöid |
|
|
|
|
|
|
|
## Tuotekehitysympäristöjen kuvaukset
|
|
## Tuotekehitysympäristöjen kuvaukset
|
|
|
|
|
|
|
|
Kuvaa ainakin seuraavat:
|
|
* Frontend kehitysympäristöinä toimii *Javascript (React), Netbeans, VisualStudio Code, Brackets*
|
|
|
|
|
* Testausympäristö: *Robotframework*
|
|
|
Frontend kehitysympäristöinä toimii Netbeans, VisualStudio Code, Brackets.
|
|
* Ajo/suoritusympäristö: *DigitalOcean, Centos7*
|
|
|
Testausympäristö on ---------
|
|
|
|
|
Ajo/suoritusympäristö on -------
|
|
|
|
|
Demoympäristö on -------
|
|
|
|
|
|
|
|
|
|
## Käytetyt työvälineet ja niiden versionumerot
|
|
## Käytetyt työvälineet ja niiden versionumerot
|
|
|
|
|
|
|
|
TBA
|
|
|
|
|
|
|
|
|
|
* Kääntäjä xyz v1.0.1
|
|
* Kääntäjä xyz v1.0.1
|
|
|
* debuggeri zky v2.05
|
|
* debuggeri zky v2.05
|
|
|
* Firefox 123
|
|
* Google Chrome Version 65.0.3325.146 (Official Build)
|
|
|
* Perustelut miksi!
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
|
|
|
|
|
## Tärkeimmät tekniset ratkaisut joihin tuote nojaa
|
|
## 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)
|
|
* Käytetyt kirjastot(library)/kehikot(Framework) (JQuery v 23456, JAVA EE 8 + Spring ZZZ, React IO)
|
|
|
* Muut jipot ja kikat
|
|
* Robotframework
|
|
|
* Perustelut miksi!
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
|
## Yleinen ohjelmisto arkkitehtuuri
|
|
|
|
|
|
|
|
## Yleinen ohjelmsto arkkitehtuuri
|
|
|
|
|
|
|
|
|
|
*
|
|
|
|
|
* Palvelut
|
|
* Palvelut
|
|
|
|
* Kirjautuminen: Koulutusvastaavan ja opiskelijan omat näkymät
|
|
|
|
* Kurssien valinta: Koulutusvastaava / Opiskelija / Yritykset
|
|
|
|
* Swipe: Swipe-näkymä kursseista yrityksille
|
|
|
|
|
|
|
|
## Palvelujen rajapinnat (Interfaces)
|
|
|
|
|
|
|
|
|
* Tarkoittaa: *Service Interface provides an entry point that consumers use to access the functionality exposed by the application. The Service Interface is usually network addressable, meaning that it is capable of being accessed by the consumer over some sort of communication network. The network address can be a well-known location or it can be obtained from a service directory such as UDDI.*
|
|
|
|
|
|
|
|
## Palvelujen/n rajapinnat (Interfaces)
|
|
Network Protocol
|
|
|
|
Data Formats
|
|
|
|
Security
|
|
|
|
|
|
|
|
* [Esimerkki elävästä elämästä](https://virkailija.opintopolku.fi/koodisto-service/swagger/index.html)
|
|
* [Esimerkki elävästä elämästä](https://virkailija.opintopolku.fi/koodisto-service/swagger/index.html)
|
|
|
|
|
|
|
|
## Suoritysympäristön (tuotanto) kuvaus
|
|
## Suoritysympäristön (tuotanto) kuvaus
|
|
|
|
|
|
|
|
* Miten tuote ajetaan tuotannossa
|
|

|
|
|
* Sijoittelunäkymä (Depoyment diagram)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Tietokantakuvaukset
|
|
## Tietokantakuvaukset
|
|
|
|
|
|
|
|
|
|
 |
|
|

|
|
\ No newline at end of file |
|
|
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TBD |
|
|