oaarne/otm-harjoitustyo

OTM-harjoitustyö

zhuLi

zhuLi is a digital research assistant, written in Kotlin. It can be used to collect and organize sources and research notes.

Releases

0.1

Documentation

User's Manual

Req. Spec

Architechture Document

Testing Document

Hours

Usage

Data will be loaded from and saved to sources.json, which will be created if it does not exist in the working directory

With the .zip

Unzip the distribution wherever and run bin/zhuLi.

From the repo

All of the commands below are to be called from the zhuLi directory (not the root of the git repo!)

zhuLi can be run by calling ./gradlew run

The sources are pulled from zhuLi/sampleSources.json

Test report can be generated by calling gradle jacocoTestReport

Style can be checked (using ktlint) by calling gradle check. If it doesn't say anything that means that there are no errors.

Docs can be generated by calling gradle dokka

Run ./gradlew assembleDist to generate distributions in both zip and tarball form.

otm-harjoitustyo's Issues

Koodikatselmointi

Koodi ladattu 3.5 ~klo 17.25.

Koodin pakkausrakenne on erittäin selvä ja toimiva.

Koodi on hyvää, näin aloittelevana kotlinkoodarina törmäsin jopa täysin uusiin asioihin.
Luokat sisältävät jonkin verran käyttämättömiä muuttujia ja funktiota, sekä paljon kommentoitua koodia. Vaikka kehityksen aikana kommentoitu koodi voikin helpottaa muistamista, se myös tekee koodin lukemisesta ulkopuoliselle hidasta ja vaikeaa. Asiaa vaikeuttaa, että kommentit saattavat olla eri tasoissa, ja joissain tapauksissa rivinvaihtoja on liian vähän (esim MainView-luokka).

Testeihin liittyvät asiat jättäisin kokonaan testitiedostoihin (JsonSourceListDaon sample-funktiot).

Isompia hassuuksia en löydä, aiken kaikkiaan hieno ohjelma. Käyttöliittymä on erittäin siisti!

PS. en saanut ohjelmaa käynnistettyä gradlew:n avulla. Error: Could not find or load main class org.gradle.wrapper.GradleWrapperMain. Ideasta gradlen avulla käynnistäminen kuitenkin onnistui.