Sovelluksen avulla käyttäjien on mahdollista pitää kirjaa tekemättömistään töistä eli todoista. Sovellusta on mahdollista käyttää useamman rekisteröityneen käyttäjän, joilla kaikilla on oma yksilöllinen tehtävälistansa.
Sovellus toimii myös Helsingin yliopiston Tietojenkäsittelytieteen kurssin Ohjelmistotekniikan menetelmät referenssisovelluksena. Sovelluksen tarkoituksena on demonstroida erästä tapaa tehdä suurin piirtein täysiin pisteisiin riittävä dokumentaatio sekä testaus projektillesi. Itse ohjelma on sen verran suppea, että saadaksesi kurssilta arvosanan 5 joudut tekemään hieman laajemman sovelluksen.
JavaFX aiheuttaa päänvaivaa ohjelmiston konfiguroinnin suhteen. Tässä repositoriossa olevan koodin pitäisi toimia riippumatta käyttämästäsi Javan versiosta. Koodi toimii ainakin laitoksen cubbli-Linuxeissa olevilla Java:n versiolla 8 ja 11.
Jos käytät Javan versiota 8 ja tämä koodi ei toimi, niin repositorion haarassa java8 on versio ohjelmasta, jonka pitäisi toimia myös Java 8:lla. Ainoat erot ovat tiedostossa pom.xml
- mainClass määritys on erilainen
- osaista dependencies ja plugins puuttuu JavaFX:n liittyvät elementit.
JavaFX:n liittyvistä ongelmista ja niiden kiertämisestä lisää täällä.
Jos et saa projektia toimimaan koneellasi, saat apua pajassa.
Testit suoritetaan komennolla
mvn test
Testikattavuusraportti luodaan komennolla
mvn jacoco:report
Kattavuusraporttia voi tarkastella avaamalla selaimella tiedosto target/site/jacoco/index.html
Komento
mvn package
generoi hakemistoon target suoritettavan jar-tiedoston OtmTodoApp-1.0-SNAPSHOT.jar
JavaDoc generoidaan komennolla
mvn javadoc:javadoc
JavaDocia voi tarkastella avaamalla selaimella tiedosto target/site/apidocs/index.html
Tiedostoon checkstyle.xml määrittelemät tarkistukset suoritetaan komennolla
mvn jxr:jxr checkstyle:checkstyle
Mahdolliset virheilmoitukset selviävät avaamalla selaimella tiedosto target/site/checkstyle.html
Homebrew on Linuxin pakettimanagereita vastaava pakettimanageri MacOS-käyttöjärjestelmälle. Nämä ohjeet toimivat ainakin MacOS:n versiolle 10.15. Asennusohjeet Homebrew'lle.
Homebrew'n asennuksen jälkeen Javan saa asennettua Macille yksinkertaisesti esimerkiksi komennolla
brew install adoptopenjdk
Mavenin saa asennettua komennolla
brew install maven
Tällöin Mavenin oletuksena käyttämä Java-versio on Java 15. Java-versioon 11 päästään asentamalla Java 11 komennolla
brew install java11
Lisäksi täytyy osoittaa Mavenille Javan versio 11. Mavenin versiolla 3.6.3_1 tämä tapahtuu muokkaamalla tiedostoa: /usr/local/Cellar/maven/3.6.3_1/bin/mvn esim. nanolla komennolla
sudo nano /usr/local/Cellar/maven/3.6.3_1/bin/mvn
HUOM Muista tarkistaa mikä versio Mavenista asentui ja muokkaa tiedostopolkuun oikea versio version 3.6.3_1 tilalle
Muokkaa rivi
JAVA_HOME="${JAVA_HOME:-/usr/local/opt/openjdk/libexec/openjdk.jdk/Contents/Home}" exec "/usr/local/Cellar/maven/
Muotoon
JAVA_HOME="${JAVA_HOME:-/usr/local/opt/openjdk@11/libexec/openjdk.jdk/Contents/Home}" exec "/usr/local/Cellar/maven/
Eli muokkaa polkuun openjdk openjdk@11 ja tallenna tiedosto. Nyt voit tarkistaa komennolla mvn --version, että Maven käyttää Javan versiota 11.
Käyttöjärjestelmän Java version vaihtaminen onnistuu esimerkiksi lisäämällä tiedoston: ~/.zshrc (vanhemmilla MacOS-käyttöjärjestelmillä ~/.bashrc) loppuun rivi
export JAVA_HOME=/usr/local/opt/openjdk@11/libexec/openjdk.jdk/Contents/Home/
Muista käynnistää lisäyksen jälkeen terminaali uudestaan, jolloin komento java --version näyttää versioksi 11.