Lukuvinkkikirjasto on web-sovellus, joka toteutetaan Helsingin Yliopiston Ohjelmistotuotantokurssin projektityönä. Sovelluksen käyttäjä voi tallettaa, hakea sekä jaotella erilaisia lukuvinkkejä sekä muistiinpanoja, kuten kirjoja, podcasteja, videoita tai blogipostauksia. Tarkemmat tiedot löytyvät tehtävänannosta.
Linkki sovellukseen: https://lukuvinkkiapp.herokuapp.com/
Materiaali on lisensoitu GNU General Public License lisenssillä.
- Product backlog
- Flinga
- Tietokantakaavio
- Definition of Done
- Sprint review
- Loppuraportti
- Hyväksymistestit - Robot Framework
Aloita kloonaamalla repositorio:
$ git clone [email protected]:TopiasHarjunpaa/Lukuvinkkisovellus.git
$ cd lukuvinkkisovellus
Asenna seuraavaksi tarvittavat riippuvuudet:
$ poetry install
Luo projektiin juurihakemistoon tiedostot .env sekä .env.test ja lisää niihin seuraavat ympäristömuuttujat
DATABASE URL=[tietokannan osoite]
SECRET_KEY=[istunnon salausavain]
Ohjelma käynnistetään komennolla:
$ poetry run invoke start
Testit voidaan suorittaa komennolla:
poetry run invoke test
Testikattavuusraportin saa generoitua komennolla:
poetry run invoke coverage-report
Raportti generoidaan kansioon nimeltä htmlcov. Testeihin, käyttöliittymään sekä triviaaleihin metodeihin liittyvä koodi on jätetty raportista pois. Testikattavuusraportti löytyy myös Codecovista
Järjestelmätestit voidaan suorittaa komennolla:
poetry run invoke robot
Laatutarkastukset voidaan suorittaa komennolla:
poetry run invoke lint
Testeihin liittyvä koodi on jätetty pois laatutarkastuksista.