|
|
|
## OBSIMO
|
|
|
|
|
|
|
|
Versio: 0.05
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Johdatus
|
|
|
|
|
|
|
|
Tässä dokumentoidaan tuotteessa käytetyt teknologiat ja suunnitteluratkaisut.
|
|
|
|
|
|
|
|
## Yleiskuvaus
|
|
|
|
|
|
|
|
OBSIMO -ohjelmisto on palvelu jolla JAMK voi saada palautetta yrityksiltä kuinka hyvin opintojaksotarjonta vastaa heidän tarpeitaan. Sovellus toteutetaan Internet palvelulla, backendiin tarvitaan myös jokin tietokanta.
|
|
|
|
|
|
|
|
* Esittele lyhyesti tuote tai kohde
|
|
|
|
* Dokumentin tehtävä on avata esim. jatkokehittäjälle käsitys siitä miten tuote on toteutettu (Pelkkä lähdekoodi ei riitä)
|
|
|
|
* Millaisia välineitä/työkaluja ja ympäristöjä tarvitaan, jos aioitaa kehitää tuotetta eteenpäin
|
|
|
|
|
|
|
|
|
|
|
|
## Käytetyt teknologiat
|
|
|
|
|
|
|
|
### Frontend:
|
|
|
|
* HTML/CSS
|
|
|
|
* JavaScript
|
|
|
|
|
|
|
|
### Backend
|
|
|
|
* SERVERSIDE TODO
|
|
|
|
* DATABASE TODO
|
|
|
|
|
|
|
|
|
|
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
|
|
|
|
## Tuotekehitysympäristöjen kuvaukset
|
|
|
|
|
|
|
|
Kuvaa ainakin seuraavat:
|
|
|
|
|
|
|
|
* Kehitysympäristö TODO
|
|
|
|
* Testausympäristö TODO
|
|
|
|
* Ajo/suoritusympäristö: TODO
|
|
|
|
* Demoympäristö TODO
|
|
|
|
|
|
|
|
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/Chrome/Edge/IE
|
|
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 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!
|
|
|
|
|
|
|
|
|
|
|
|
## 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 |