Klusterin nettisivut

Dokumentaatiot

• Product Backlog
• Sprint 0 Task Board
• Sprint 1 Task Board
• Sprint 2 Task Board
• Sprint 3 Task Board
• Sprint 4 Task Board
• Sprint 5 Task Board
• Sprint 6 Task Board

Definition of Done

• Taski toteutettu kuten pitää.
• Pylint score mahdollisimman korkea (8.00).
• Dokumentaatio suomeksi.
• Koodi englanniksi.
• Testikattavuus 70%.
• Toimii tuotantoympäristössä.

Asennus ja käyttö

Nettisivuja voi suorittaa lokaalisti seuraavien ohjeiden avulla:

Backend

Käynnistäminen

Mene backend-hakemistoon

~klusteri-website/$ cd backend 

Asenna riippuvuudet ja käynnistä virtuaaliympäristö

poetry install
poetry shell

Tietokannan rakentaminen

Katso ohjeet tietokannan pystyttämiseksi täältä

Jos koodissa määriteltyjä tietokantatauluja on muokattu, on luotava uusi migraatio tietokantaa varten. Seuraava komento luo migraatiotiedoston

python manage.py makemigrations

.env-tiedostossa määriteltyyn tietokantaan luodaan tietokantataulut migraatiotiedoston avulla automaattisesti seuraavalla komennolla

python manage.py migrate

Käynnistä backend

python manage.py runserver

Testien suorittaminen

Mene backend-hakemistoon

~klusteri-website/$ cd backend 

Aja seuraava komento

python manage.py test tests

Testit voi ajaa myös pytestin avulla

poetry run coverage run --branch -m pytest

Tällöin testikattavuusraportin saa tulostettua konsoliin komennolla

coverage report

Pylint testin suorittaminen onnistuu komennolla

pylint backend

Frontend

Käynnistäminen

Mene frontend-hakemistoon juuresta. Asenna riippuvuudet komennolla:

npm install

Käynnistä frontend komennolla:

npm run dev

Testaaminen

Mene frontend-hakemistoon. Aja testit komennolla:

npm test

Aja Eslint komennolla:

npx eslint src

Cypress-testeille löytyy ohjeet täältä.

Codecov ja coverage

Testikattavauusraportit lähetetään automaattisesti Codecoviin CI:n yhteydessä

Raportit muodostetaan seuraavilla komennoilla

Raportin muodostaminen backendille

~klusteri-website/backend/$ poetry run coverage xml

Raportin muodostaminen frontendille

~klusteri-website/frontend/$ npx jest --coverage

Huom! Codecov ei toistaiseksi ota huomioon cypress-testejä