Ohjelmistokehityksen sovellusprojekti (TVT Monimuoto)

Projektissa opiskelijat työskentelevät neljän hengen ryhmissä ja toteuttavat tässä dokumentissa kuvatun sovelluksen. Tavoitteena on, että opiskelijat syventävät aiemmilla kursseilla hankkimiaan ohjelmointitaitoja, perehtyvät ohjelmistokehitysprojektin käytännön toteuttamiseen ja oppivat käyttämään versionhallintaa (Git) tehokkaasti.

Projektityön kuvaus

Opiskelijoiden tehtävä on suunnitella ja toteuttaa pankkiautomaattijärjestelmä, jonka ohjelmiston rakenne on seuraava:

Projektikuva

Qt-sovellus toimii, niin että kun sovellus käynnistyy avautuu aloitusikkuna ja kun kortinlukijaan laitetaan kortti, avautuu PIN-koodin kyselyikkuna. Jos annetaan oikea PIN-koodi avautuu sovelluksen päävalikko, josta voidaan valita myöhemmin kerrotut toimenpiteet.

Huom! Monimuotoryhmissä ei käytetä kortinlukijaa, joten he lisäävät aloitusikkunaan painikkeen, joka avaa PIN-koodin kyselyikkunan ja siihen kirjoitetaan kortinnumero ja PIN-koodi.

Työ sisältää

Huom! Edellä mainitut kuuluvat kurssin sisältöön ja arviointi perustuu niiden osaamiseen, joten siksi millään muilla tekniikoilla noita ei saa korvata.

Oppimistavoitteet

Arviointi

Ryhmän luoma sovellus arvioidaan tässä dokumentissa esitettyjen kriteerien mukaisesti. Kuitenkin jokainen opiskelija arvioidaan yksilöllisesti ja arvioinnissa huomioidaan seuraavat asiat:

Arvosanaa ei voi korottaa myöhemmin.

Vertais- ja itsearvioinnin kohteet

Sovelluksen arviointi

Vähimmäisvaatimukset sovellukselle (arvosana 1)

Vähimmäisvaatimukset (arvosana 2)

Hyvän arvosanan vaatimukset (arvosana 3)

Hyvän arvosanan vaatimukset (arvosana 4)

Kiitettävän arvosanan vaatimukset (arvosana 5)

Tiivistelmä sovelluksen arviointikriteereistä

Nämä ovat ohjelmistokokonaisuutta projektihallinnallisesta näkökulmasta koskevat minimit (arviointi):

  1 2 3 4 5
Versionhallinnan käyttö x x x x x
Viikkopalaverit x x x x x
Toiminnallinen määrittelydokum. x x x x x
Tekninen määrittelydokum. x x x x x
Projektin kuvaus (README) x x x x x

Nämä ovat itse ohjelmistokokonaisuutta koskevat minimit (arviointi):

  1 2 3 4 5
Kirjautuminen PIN-koodilla x x x x x
Saldon näyttö x x x x x
Rahan nosto (20,40,50,100) x x x x x
Tilitapahtumien näyttö x x x x x
Debit kortti x x x x x
Jwt-autentikointi   x x x x
PIN-koodille 10 s timer   x x x x
Kaikki CRUD-operaatiot   x x x x
Credit kortti     x x x
Rahan nosto (muu summa)     x x x
PIN-lukitus istunnolle     x x x
PIN-lukitus tietokantaan       x x
30 s timerit       x x
Tilitapahtumien selaus       x x
Kaksoiskortti         x
Lisäominaisuus         x

Arvosanaa alentavia seikkoja

Oppilaskohtaisessa arvioinnissa huomioidaan

Dokumentit

Tässä ohjeessa on määritelty, mitä teknologioita projektissa tulee käyttää. Dokumentit laaditaan kuitenkin ikään kuin teknologiat olisi valittu projektin suunnitteluvaiheessa. Teknologiavalintoja perustellaan teknisessä määrittelyssä osana projektin suunnitteluratkaisuja. Vaatimusmäärittelyssä ei oteta kantaa teknologioihin, kuten käytettävään tietokantajärjestelmään.

Esimerkkejä README-tiedostoista:

Työkaluja kaavioiden luontiin

Suosittelemme käytettäväksi Mermaidia: https://mermaid.ai/

Muita yleisesti käytettyjä:

Vaatimukset tietokannalle

Kun toteutetaan credit-kortti ominaisuus

Edellisten vaatimusten lisäksi:

Kun toteutetaan kaksoiskortti

Edellisten vaatimusten lisäksi:

Pankin tietomallin realistisuus

Vinkkejä tietokannan suunnitteluun

Oppimateriaalit

Pekka Alaluukas kurssimateriaalit

Teemaluentoja: AI, IaC, CI/CD, reverse proxy, ohjelmistiolisensseistä (Teemu Korpela)

Ohjelmistokehityksen perusteet ja UML-mallinnus videot Yujassa (Teemu Leppänen)

Viikkopalavereiden yleinen agenda

Alla kunkin viikon kohdalla on tarkistuslista, jonka ideana on varmistaa, että sovellus valmistuu ajoissa. Ryhmän tulisi tehdä vähintään listan mukaiset tehtävät. Jos etenette nopeammin, esittäkää palaverissa myös ylimääräiset tehtävät. Jos jotain listassa mainittuja asioita jää tekemättä, esittäkää kuinka saatte ne tehtyä seuraavan viikon aikana, niin että aikataulussa pysytään.

Viikko 1

1. Päivän / TEHTÄVÄT

  1. Luodaan neljän hengen ryhmät Excel-dokumentissa

  2. Jokainen opiskelija luo tunnuksen itselleen sivustolla https://peatutor.com/project_app/register/tvt26kmo

    • Voit keksiä minkä hyvänsä tunnuksen (joka on vapaa)
    • Rekisteröityä voi vain oamk.fi ja oulu.fi sähköposteilla
    • Luotuasi tunnuksen, saat sähköpostin, jossa on tunnuksesi ja salasanasi. Pidä ne tallessa.

    Huom! Tarkista ennen rekisteröitymistä, mikä on sinun GitHub-tunnus, koska se on annettava rekisteröityessä.

  3. Jokaisesta ryhmästä yksi luo kurssin Teams-kanavan ALAISUUTEEN (ei siis kokonaan uutta Teams-kanavaa) uuden PRIVAATIN alikanavan, jolla on sama nimi kuin ryhmällä Excelissä eli group_1, group_2, ….

Loppuviikon / TEHTÄVÄT

Viikko 2

Viikko 3

Viikko 4

Viikko 5

Viikko 6

Viikko 7

Viikko 8

Projektin alustaminen

Noudata tarkasti alla olevia ohjeita ja lisäksi voit katsoa ohjevideon osoitteesta:
https://www.youtube.com/watch?v=_lfn6vsrOJY Huomaa kuitenkin, että allaoleva ohje on uudistettu videon luonnin jälkeen. —

1. Repositoryn alustaminen

Yksi ryhmän opiskelijoista alustaa GitHub-repositoryn seuraavasti:

# Kloonaa repon omalle koneelleen
git clone <repository-url> 

cd groupx  # jossa groupx on kloonattu kansio ja x oman ryhmän numero
git checkout -b initialize

mkdir documents
mkdir database

2. Backendin alustaminen

Anna groupx kansiossa seuraavat komennot

mkdir backend
cd backend
npx express-generator --no-view
npm install

Huom! Tuo express-generator asentaa hieman vanhat npm-paketit, joten voitte halutessanne korvata tuon npx komennon seraavilla komennoilla (jotka ajetaan backend kansiossa):

npm init
npm install express mysql2 bcryptjs jsonwebtoken dotenv
mkdir routes
mkdir models

Ja sitten app.js rakennetaan kuten luennoilla on opastettu.


3. Qt-sovelluksen alustaminen

  1. Käynnistä Qt Creator
  2. Luo Qt Widget -tyyppinen sovellus, jonka nimeksi bank-automat
  3. Tallenna sovellus kansioon groupx
  4. Käännä sovellus
  5. Tarkista, että bank-automat-kansion alle ilmestyi build-kansio
  6. Jos build-kansiota ei ilmesty:

4. .gitignore-tiedoston luominen

Luo tiedosto projektikansion groupx juureen ja kirjoita siihen seuraavat rivit:

backend/node_modules/
bank-automat/build/
bank-automat/.qtcreator/
bank-automat/*.user 

5. Muutosten lisääminen ja pushaaminen

Suorita komennot kansion groupx juuressa:

git add .
git commit -m "projekti alustettu"
git push origin initialize

6. Tarkistukset GitHubissa

Varmista, että GitHubissa näkyy seuraavat kansiot:

Ja että seuraavat eivät ole GitHubissa:


7. Pull Request


8. Branchin yhdistämisen jälkeen

Henkilö, joka teki alustusvaiheet

git checkout main
git pull origin main

Muut ryhmän jäsenet

Lisäominaisuusideoita

(arvosanan 5 tarvitaan vähintään yksi tällainen lisäominaisuus)

Kuvan lataus ja näyttäminen

Idean esittelyvideo: https://www.youtube.com/watch?v=DlKRlZTNYl8

Toimintaperiaate:

REST APIssa voi käyttää Multer-moduulia.

Swagger dokumentointi

Idean esittelyvideo: https://www.youtube.com/watch?v=M6Fj5Y2K24w
https://www.npmjs.com/package/swagger-ui-express

Logitus

WebSocket

Toteutetaan WebSocketeilla jokin toiminto sovellukseen (vaikutus arvosanaan 1).

Idean esittely: https://youtu.be/QGnv7s0JIIo

Docker

Sovelluksen ajaminen Dockerissa (vaikutus arvosanaan 1).

Testien lisääminen backendiin

Esimerkiksi jest ja supertest (vaikutus arvosanaan 1)

Esittelyvideo: https://youtu.be/3grg6_fPAsA

Tai Postman CLI

Esittelyvideo: https://youtu.be/Wvv8GWQdvKU Huomaa, että videolla esittelen collectionin ajamista Newman nimisellä työkalulla. Se kannattaa nykyään korvata Postman CLI:llä.

CI/CD

Kafka

-Apache Kafkan käyttö järjestelmien väliseen viestinvälitykseen. Kafka voidaan ottaa käyttöön esimerkiksi Aivenin pilvipalvelussa.

-Ota Kafka käyttöön ja rakenna Node.js-sovellus, joka vastaanottaa Kafka-viestejä ja näyttää ne käyttäjälle.

-Pekan esimerkkivideo: https://youtu.be/Cf4B9XYzq7k

Verkkopankin toteuttaminen

Ylimääräinen Qt-sovellus

Generatiiviset tekoälyt (AI-koodaus) ja vastaavat apuvälineet. Ohjaajien (ja yleisestikin IT-opettajien) ajatuksia aiheesta:

Softalisensseistä

Kirjat ja kurssit taustatiedoksi ja malliksi

Tee tunnus O'Reillyn verkkokirjastoon students.oamk.fi:n sähköpostilla: https://libguides.oulu.fi/oreilly ja valitse institution not listed. Tuo on kaupallinen palvelu, mihin Oamkin kirjasto on ostanut pääsyn. Kannattaa käydä selailemassa tuota online-kirjastoa muutenkin.

Aika tunnettuja ja arvostettuja ohjelmistotekniikan kirjoja. Enemmistö näistä kirjoista suoraan tästä tweetistä:

Qt-aiheiset (ei tiedoa laadusta):

Node.js (ei tieto laadusta):

Linux-aiheiset (ei tieto laadusta):

UML (ei tietoa laadusta):

API (ei tietoa laadusta):

MySQL (ei tietoa laadusta):

Ohjaajien kommentteja ja vinkkejä