NL Portal
  • Welkom bij NL Portal
  • Fundamentals
    • Wat is NL Portal
    • Architectuur
      • 5-lagenmodel
      • Integraties
        • Zaak
        • Mijn gegevens
        • Product
      • Patronen
        • Verzoek
        • Externe Taak
      • Authentication en authorization
    • Features
    • Object filtering
    • Open source
  • Configuratie
    • Opzetten NL Portal
    • Eigen vormgeving
    • Connectiviteit
    • Deployment guide
    • Token exchange
  • Support en resources
    • Best practices
    • Community en support
    • Repositories
    • Impressies
  • Product management
    • Governance
    • Roadmap
  • Release notes
    • Release notes
    • 1.x.x
      • 1.1.0
        • Release notes
      • 1.4.0
        • Release notes
      • 1.4.1
        • Release notes
      • 1.5.0
        • Release notes
      • 1.5.1
        • Release notes
  • Contributing to NL portal
    • Contributing to NL portal
Powered by GitBook
On this page
  • Wat heb je nodig
  • Je eerste NL Portal app
  • Vervolg stappen
  1. Configuratie

Opzetten NL Portal

PreviousOpen sourceNextEigen vormgeving

Last updated 2 months ago

Wat heb je nodig

Om de NL Portal op te zetten is er enige kennis van technische tools en de CLI (command-line interface) vereist.

Waar kan ik de code vinden

Alle code en informatie is opensource en kan gevonden worden op . De NL Portal is opgesplitst in meerdere repositories. Hieronder een korte beschrijving van elk.

Repository
Beschrijving

Documentatie over de NL Portal

Template om een nieuwe NL Portal app frontend te starten, de perfecte basis om mee beginnen

Template om een nieuwe NL Portal app backend te starten

Libraries voor de frontend die gebruikt worden in de frontend template

Libraries voor de backend die gebruikt worden in de backend template

Een docker compose setup om het ZGW landschap op te zetten die gebruikt kunnen worden door de NL Portal

Kubernetes Helm charts die het makkelijker maakt om een NL Portal omgeving op te zetten op de kubernetes cluster

Niet al deze repositories zijn nodig om een NL Portal app te maken. Hieronder vind je een stappen plan waarmee je kan beginnen!

Je eerste NL Portal app

Om een minimale versie van de NL Portal op te zetten zal je de enkele repositories moeten clonen op je lokale machine en 1-voor-1 uitvoeren.

Frontend

De eerste repository is de deze geeft een goede start voor eventueele aanpassingen die je wilt doen om de frontend eigen te maken. In het README.md bestand staat wat je moet uitvoeren en benodigd hebt onder het kopje Development.

Authenticatie

Als je dan weer naar de NL Portal gaat, dan zal je zien dat je nu wordt doorgestuurd naar een Keycloak loginscherm. Hier kan je inloggen met gebruiker burger en wachtwoord burger.

Backend

Zodra de backend draait kan je de NL Portal app refreshen in je browser, en dan zie je dat er ook data beschikbaar is. Je eerste NL Portal app is een feit!

Vervolg stappen

Nu de eerste NL Portal app gemaakt is kan je verder werken aan de NL Portal om het eigen te maken. Updaten van de vormgeving, aanpassen van de menu's en meer. Het staat je tenslotte geheel vrij om de NL Portaal te pakken en deze aan te passen naar jou wensen. Opties zijn om te koppelen met Openzaak, Objects API, OpenKlant en/of HaalCentraal.

Zodra de frontend draait, zal je merken dat je doorgestuurd wordt naar een pagina die niet bestaat. Dit komt omdat standaard de NL Portal authenticatie verloopt via en om het opzetten en developen voor de NL Portal makkelijker te maken hebben wij een repository gemaakt waar alle benodigdheden om de NL Portal op te starten in zit.

Wanneer je voor het eerst de NL Portal opstart zonder een Keycloak instantie

Voor nu is het genoeg om alleen Keycloak en database only stukje te volgen in de README.md van de repository.

Keycloak inlogscherm

Nu ben je ingelogd via Keycloak op de NL Portal, maar je kan niet zoveel aangezien de NL Portal nog niet aangesloten is op de backend. Hiervoor ga je naar de repository en volg je de stappen in de README.md.

Eerste stap in het maken van je eigen NL Portal app

github.com
Frontend Template
Keycloak
Docker Compose
Docker Compose
Backend Template
Documentatie
Frontend Template
Backend Template
Frontend Libraries
Backend Libraries
Docker Compose
Helm Charts