Projektin loppuraportti on luettavissa linkin takaa.

Scrumin mukaisesti projektissa toteutetaan backlogista löytyvät user storyt, joille on jokaiselle määritelty hyväksymiskriteerit. Projektin product- ja sprint-backlogit ja siten myös hyväksymiskriteerit löytyvät tästä sheetistä: backlogit

Hyväksymiskriteerit testataan käyttäen Robot-frameworkia. Koodia testataan kattavasti myös unit testeillä. Koodityyli noudattaa pylintin avulla määriteltyjä sääntöjä.

Asiakas voi seurata koodin ja testien tilannetta CI-palvelusta: codecov

Koodin arkkitehtuuri on suunniteltua ja perusteltua, pyrkimyksenä on mahdollisimman hyvä ylläpidettävyys pitämällä koodi selkeänä.

• Tuotettu koodia suunnitelluille toiminnallisuuksille
• User storyn vaatimuksiin vastattu
• Projekti käynnistyy ilman virheitä
• Unit testit kirjoitettu ja läpäisty
• Toiminnallisuus on testattu hyväksymistesteillä
• Refraktorointi on valmis
• Product ownerin mielestä toiminnallisuus on valmis

• Definition of done sprintin user storyille täytetty
• Kaikki unit testit läpäisty
• Linttaus läpäisty
• Backlog on päivitetty
• Kaikki bugit on korjattu
• Sprintin toteutettu toiminallisuus käyty läpi Product Ownerin kanssa
• Sprinttiin liittyvät "to do" asiat valmiita

• Koodi on valmista
• Kaikki testit läpäisevät
• Kaikki hyväksymiskriteerit täyttyvät
• Ryhmä on hyväksynyt releasen
• Ei keskeneräistä työtä releasen mukana
• Kaikki DoD asetetut vaatimukset täyttyvät

Ohjelma toimii paikallisesti, tähän mennessä valmiit ominaisuudet on listattu projektin backlogeissa.

Ohjelma toimii komentoriviltä tekstikättöliittymällä. Kloonaa koneellesi tämä repositorio ja siirry sen juurihakemistoon.

Asenna projektin riippuvuudet suorittamalla sen juurihakemistossa komento

poetry install

Sovellus käynnistyy komennolla

poetry run python3 lukuvinkkikirjasto/index.py

Vaihtoehtoisesti voit siirtyä ensin virtuaaliympäristöön komennolla poetry shell ja tämän jälkeen suorittaa komennon python3 lukuvinkkikirjasto/index.py.

Ohjelman käynnistyttyä voit antaa komentoja ohjelmalle. Ohjeet komentojen käytöstä tulostuvat kun käynnistät ohjelman. Komennot:

• "a" Lisää vinkki,
• "p" Tarkastele vinkkejä,
• "f" Muokkaa suodattimia,
• "c" Muokkaa vinkkiä,
• "q" Poistu sovelluksesta.

Lisää vinkki komennon avulla voit lisätä tietokantaan blogi, video ja kirja tyyppisiä vinkkejä. Tarkastele vinkkejä tulostaa oletuksena kaikki tietokantaan lisätyt vinkit. Mikäli haluat rajata mitä tulostetaan, se onnistuu muokkaamalla suodattimia. Yksittäisten vinkkien muokkaaminen, mm kommentointi ja poistaminen tapahtuu komennon muokkaa vinkkiä avulla. Lisäksi voit lisätä vinkeille tageja tai merkata ne luetuiksi.

This project is licensed under the terms of the MIT license.