|
|
|
## Tekninen dokumentaatio
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
## Otsikko
|
|
|
|
|
|
|
|
Versionumero
|
|
|
|
|
|
|
|
Luokittelu (Salainen/Julkinen etc..)
|
|
|
|
|
|
|
|
Vastuuhenkilö
|
|
|
|
|
|
|
|
Versionumero 0.2.1
|
|
|
|
|
|
|
|
Luokittelu (Julkinen)
|
|
|
|
|
|
|
|
Vastuuhenkilö: Joona
|
|
|
|
|
|
|
|
|
|
|
|
## Johdatus
|
|
|
|
|
|
|
|
* Johdatus dokumenttiin..
|
|
|
|
|
|
|
|
|
|
|
|
* Tässä tietoa teknisestä toteutuksesta. Teemme web-pohjaisen palvelun/käyttöliittymän OBSIMO. Tämä dokumentti tuo antaa jatkokehittäjälle käsityksen siitä mitä tekniikoita on käytetty. Projektin lähtökohtana on Jyväskylän ammattikorkeakoulun tarve kehittää opiskelijoiden henkilökohtaisen opiskelusuunnitelman (HOPS) muodostamista. Projekti toteutetaan Jyväskylän ammattikorkeakoulun informaatioteknologian instituutin järjestämien TTOS0800 Ohjelmistoprojekti sekä TTOS0900 ohjelmistotestaus ‑opintojaksojen puitteissa.
|
|
|
|
|
|
|
|
|
|
|
|
## Yleiskuvaus
|
|
|
|
|
|
|
|
* 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
|
|
|
|
|
|
|
|
* OBSIMO -opintopolkusuunnittelu/arvostelupalvelu
|
|
|
|
|
|
|
|
## Käytetyt teknologiat
|
|
|
|
|
|
|
|
* JAVA / Java Script ?
|
|
|
|
* HABA kieli
|
|
|
|
* Perustelut miksi!
|
|
|
|
* HTML
|
|
|
|
* CSS
|
|
|
|
* JavaScript
|
|
|
|
* PHP 7.0.22
|
|
|
|
* MySQL:llä 14.14
|
|
|
|
|
|
|
|
|
|
|
|
## Tuotekehitysympäristöjen kuvaukset
|
|
|
|
|
|
|
|
Käytämme AWS palveluja. Löydämme tästä kaikki tarvittava kehitykseen, testaukseen jne.
|
|
|
|
Kuvaa ainakin seuraavat:
|
|
|
|
|
|
|
|
* Kehitysympäristö
|
| ... | ... | @@ -49,15 +38,15 @@ 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
|
|
|
|
* Chrome (Versio 64.0 ja ylöspäin)
|
|
|
|
* Firefox (Versio 58.0.2 ja ylöspäin)
|
|
|
|
* Perustelut miksi!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Tärkeimmät tekniset ratkaisut joihin tuote nojaa
|
|
|
|
|
|
|
|
* React
|
|
|
|
* JQuery
|
|
|
|
|
|
|
|
* Käytetyt kirjastot(library)/kehikot(Framework) (JQuery v 23456, JAVA EE 8 + Spring ZZZ, React IO)
|
|
|
|
* Muut jipot ja kikat
|
| ... | ... | @@ -66,8 +55,13 @@ Eli miten nuo eri ympäristöt on toteutettu ko. projektissa |
|
|
|
|
|
|
|
## Yleinen ohjelmsto arkkitehtuuri
|
|
|
|
|
|
|
|
*
|
|
|
|
* Palvelut
|
|
|
|
* Apachea 2.4.18
|
|
|
|
* Linux Ubuntu 16.04
|
|
|
|
* Palvelin
|
|
|
|
- 512 MB Memory
|
|
|
|
- 1 Core Processor
|
|
|
|
- 20 GB SSD Disk
|
|
|
|
- 1 TB Transfer
|
|
|
|
|
|
|
|
|
|
|
|
## Palvelujen/n rajapinnat (Interfaces)
|
| ... | ... | |
| ... | ... | |
