Getting Started

This guide will help you get Erfgoedzoeker up and running on your local machine.

Prerequisites

Data Layer Dependency

Erfgoedzoeker requires a data layer endpoint to query. NDE's data layer specification is still in development, so both GraphQL and REST protocols are supported. You select the protocol via api.type in the config file.

Available data layer implementations:

• GraphQL (in development): LOL (Linked Open Limburg) provides a Docker Compose setup that spins up a local GraphQL endpoint at http://localhost:4000/graphql.
• REST: A hosted demo is available at https://datalaag.erfgoedzoeker.nl/v1 (see this repo for self-hosting).

• Node.js v20.19.0 (or newer) and pnpm
• A data layer endpoint (see above)

Installation

Clone the repository and install dependencies:

git clone https://github.com/Simon-Dirks/erfgoedzoeker.git
cd Erfgoedzoeker-NDE
pnpm install

Configuration

Erfgoedzoeker is configured through a single JSON file at apps/erfgoedzoeker/public/config/erfgoedzoeker.config.json. The easiest way to configure it is through the Configurator app:

pnpm run configurator:dev

Open http://localhost:5173/, adjust settings, download the generated JSON, and replace the config file. To configure it directly or learn about the schema, see Configuration System.

Running the Application

Start the development server:

pnpm run start

Navigate to http://localhost:4200/ to see the application in action.