vinkr
vinkr on syksyn 2019 Ohjelmistotuotanto-kurssin miniprojekti, jossa tehtävänä on luoda lukuvinkkejä hallinnoiva sovellus. Sovellusta käytetään tekstikäyttöliittymällä komentorivin kautta.
Asennus- ja käyttöohje
Lataaminen
Hanki sovellus kloonaamalla tämä Git-repositorio:
git clone git@github.com:Ohjelmistotuotanto-DoD/vinkr.git
tai lataa projekti ZIP-tiedostona painamalla oikean yläkulman vihreää "Clone or download" -nappia ja valitsemalla "Download ZIP". Pura ZIP haluamaasi sijaintiin.
Buildaaminen
Komento
./gradlew build
luo kansioon build/libs ajettavan jar-tiedoston vinkr-all.jar.
Ajaminen
Avaa terminaali projektin juureen ja käynnistä sovellus komennolla:
./gradlew run -q --console=plain
nyt tekstikäyttöliittymän tulisi käynnistyä.
Jar-tiedoston voi ajaa komennolla:
java -jar vinkr-all.jar
Huomaa että buildattaessa jar ei sijaitse projektin juuressa.
Käyttäminen
Kun projekti käynnistyy, tekstikäyttöliittymä toivottaa sinut tervetulleeksi näyttävällä taideteoksella sekä listaamalla kaikki käytettävissä olevat komennot ja niiden toiminnallisuuden:
Kaikki käytettävissä olevat komennot: apua: Tulosta tämä lista uudestaan lisaa: Lisää uusi lukuvinkki listaa: Listaa kaikki lukuvinkit avaa: Avaa annetun vinkin sisältämä linkki lue: Päivitä olemassa olevan vinkin lukuprosenttia tallenna: Tallenna vinkit lopeta: Sulje sovellus
Ohjelmaa käytetään syöttämällä komentoja komentotulkkiin. Komennoilla on autotäydennys Tab-näppäimellä kun projektia ajaa jar-tiedostosta.
Releaset
Backlogit
Definition of done
Burndown-käyrät & edistyminen
Taskien edistyminen ja burndown-käyrät (sprintit eri välilehtinä)
Storyjen hyväksymisehdot
Sprinttiin 2 valitut storyt ja niiden hyväksymisehdot
Sprintiin 3 valitut storyt on kirjattu backlogiin sekä alle milestoneina, linkit cucumber-featureihin milestoneissa:
- Käyttäjä voi syöttää komennon ensimmäiset kirjaimet jonka jälkeen ohjelma täydentää komennon loppuosan automaattisesti
- Käyttäjä voi merkitä lukuvinkkiin kuinka monta prosenttia siitä on lukenut, nähdä vinkkien lukuprosentit listauksessa ja päivittää niitä
- Käyttäjä voi hakea kirjaVinkin tiedot automaattisesti verkosta syöttämällä teoksen ISBN-numeron
- Käyttäjä voi tunnistaa eri vinkkityypit värien perusteella ja nähdä niiden lukuasteen (aloittamatta/kesken/valmis) lukuprosentin väristä
- Käyttäjä voi lisätä tageja lukuvinkkeihin niin, että ne näkyvät vinkin tiedoissa (Toteuttamatta)
Lisenssi
vinkr on lisensoitu MIT-lisensillä