...

Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af NAP platform services, skal sættes op, kodens struktur, samt hvordan koden bygges, deployes og testes.

Forudsætninger

Krav til software:

Generelt om udviklingsmiljø for projekterne

Det lokale udviklingsmiljø på projekter er opsat med docker-compose.

For at kunne køre de compose filer, der bliver beskrevet nedenfor, kræves et docker netværk kaldet nap_net. Hvis dette ikke allerede er lavet kør "docker network create nap_net".

I hvert projekt ligger der en compose mappe, hvori der findes forskellige compose filer til udvikling, test og release.

Udvikling

Vær opmærksom på kun at køre en service af samme navn, fx kun køre en nap-test-web. Hvis der skiftes setup, stop altid servicen og kør "docker-compose down".

Der udstilles ingen porte på docker-hosten, og alt trafik routes således igennem en lokal reverse proxy https://svn.nspop.dk/svn/components/nap/nap-compose/ som også er på Docker netværket nap_net og eksponeret på port 8080 på localhost.

Ved hhv nap-admin-web, nap-lobby-web og nap-test-web, bliver ./src folderen og konfigurationsfiler fra compose/configuration "volume-mappet", hvilket betyder, at ændringer i kildekoden bliver komplieret og deployet med det samme. 

Hvis dependencies ændres skal containeren bygges igen, ellers er det fremover nok at køre `docker-compose up` når services skal startes.

Test

Jenkins bygger og deployer i snapshot versioner af NSPs wildfly container. Dette byg kan testes ved at køre at `docker-compose up` i compose/test. 

Apllikationen kan nåes på samme url som ovenfor. 

Release

Bruges udelukkende i produktions øjemed

nap-admin-web

Indeholder et angular projekt, der har til formål at vise og håndtere alle tilgængelig projekter. Projektet bruger standard strukturen for et Angular projekt, dvs. alt koden ligger inde i src/ mappen.

...

Hjælp giver et link til at oprette en support sag. 

...

Udviklingsmiljø

Installer afhængigheder

Installer dependencies ved at køre npm install --registry https://nexus.nspop.dk/nexus/repository/nsp-npm/

...

For at starte en web pack dev server kør "npm run start".  Dette vil starte projektet på i docker køres "docker-compose build && docker-compose up" fra compose/develop mappen.

Applikationen kan nu nåes  http://localhost:4500/. 8080/nap/admin/web/, hvis nap-compose reverse proxy er opsat som beskerevet tidligere, ellers på http://Localhost:4500.

Hvis nap-administration backenden ikke skal køre, kan den "mockes" væk, således der vises dummy projekter. Dette kan gøres ved at køre "npm run start:mock" . hvis det køres lokalt, ellers kan der i compose/develop ændres i docker-compose.yml "Command" parameter, hvor der tilføjes "--configuration=mock"

CI

Jenkins filen beskriver jenkins pipelinen.

...

Hjælp beskriver hvad applikation omhandler, samt et link til at oprette en support sag. 

...

Udviklingsmiljø

Installer afhængigheder

Installer dependencies ved at køre npm install --registry https://nexus.nspop.dk/nexus/repository/nsp-npm/

...

For at starte en web pack dev server kør "npm run start".  Dette vil starte projektet på i docker køres "docker-compose build && docker-compose up" fra compose/develop mappen.

Applikationen kan nu nåes  http://localhost:4200/. 8080/nap/lobby/web/, hvis nap-compose reverse proxy er opsat som beskerevet tidligere, ellers på http://Localhost:4200.

Hvis nap-administration backenden ikke skal køre, kan den "mockes" væk, således der vises 3 dummy projekter. Dette kan gøres ved at køre "npm run start:mock" . hvis det køres lokalt, ellers kan der i compose/develop ændres i docker-compose.yml "Command" parameter, hvor der tilføjes "--configuration=mock"

CI

Jenkins filen beskriver jenkins pipelinen.

...

Der er separate tests cases, som kan køres enkeltvis eller samlet.  

...

Udviklingsmiljø

Installer afhængigheder

Installer dependencies ved at køre npm install --registry https://nexus.nspop.dk/nexus/repository/nsp-npm/

...

For at starte en web pack dev server kør "npm run start".  Dette vil starte projektet på i docker køres "docker-compose build && docker-compose up" fra compose/develop mappen.

Applikationen kan nu nåes  http://localhost:4300/. 8080/nap/test/web/, hvis nap-compose reverse proxy er opsat som beskerevet tidligere, ellers på http://Localhost:4300.

CI

Jenkins filen beskriver jenkins pipelinen.

...