eperusteet-ui

1. Palvelun tehtävä

Opetussuunnitelmien perusteiden laadintatyökalun käyttöliittymä.

2. Arkkitehtuuri

3. Kehitysympäristö

3.1. Esivaatimukset

Asenna haluamallasi tavalla (esim nvm) Node.js 14 LTS

Rajapintojen generointi

Projekti käyttää eperusteet-frontend-utilsia joka otetaan käyttöön gitin submodulena. Tämä onnistuu ajamalla projektin juuressa git submodule update --init --recursive

Tämän jälkeen generoi typescript interfacet backendin rajapinnasta ajamalla seuraavat komennot:

cd eperusteet-frontend-utils/vue
yarn install
yarn gen:api

Tämän jälkeen poista node_modules-kansio eperusteet-frontend-utils/vue alta ja aja vielä yarn install koko projektin juuressa.

Rajapintojen generointiin käytetään oletuksena eperusteisiin generoitua apikuvausta Tiedoston voi ylikirjoittaa ympäristömuuttujalla EPERUSTEET_SPECFILE osoittamaan hakemistoon.

3.2. Testien ajaminen

# Kaikki testit
yarn test

# Ainoastaan yksikkötestit
yarn test:unit

# Pitää testit käynnissä
yarn test:unit:dev

# e2e testit
yarn test:e2e

# Editoi e2e testejä
yarn dev:e2e

3.4. Ajaminen lokaalisti

Kehitysympäristön käynnistys

Käynnistä ensin eperusteet backend

Sen jälkeen komento:

yarn serve

Lähdekoodin analysoiminen

yarn lint

# Korjaus automaattisesti
yarn lint:fix

yarn test:unit:coverage

Tuotantoversion buildaus

yarn build

3.4.1. Kikkoja lokaaliin kehitykseen

3.6. Versiohallinta

4. Ympäristöt

4.1. Testiympäristöt

Testiympäristöjen swaggerit löytyvät seuraavista osoitteista

• untuva
• hahtuva
• QA eli pallero

4.3. Lokit

4.4. Continuous integration

https://github.com/Opetushallitus/eperusteet-ui/actions

5. Koodityyli

Suositeltavia resursseja:

• Vue style guide
• BootstrapVue

ePerusteet-projektit

Projekti	Build status	Maintainability	Test Coverage	Known Vulnerabilities
ePerusteet
ePerusteet-amosaa
ePerusteet-ylops
ePerusteet-ui
eperusteet-ylops-ui
ePerusteet-amosaa-ui
ePerusteet-opintopolku
ePerusteet-backend-utils
ePerusteet-frontend-utils