Skip to content

Getting Started

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

Prerequisites

Data Layer Dependency

Valeros is built on top of the NDE's data layer API specification. The data layer provides a standardized API for retrieving heritage datasets. Valeros consumes this API to power its search, filtering, and data presentation features.

By default, Valeros works with a hosted demo implementation (see this repo for self-hosting), but you can also implement your own data layer following the API specification.

  • Node.js v20.19.0 (or newer) and npm
  • A publicly available data layer endpoint (the hosted demo at https://datalaag.valeros.nl/v1 works out of the box)

Installation

Clone the repository and install dependencies:

bash
git clone https://github.com/Valeros-LD/Valeros-NDE.git
cd Valeros-NDE
npm install

Configuration

To use a different data layer endpoint, update the baseUrl in src/app/config/api.config.ts:

typescript
export const API_CONFIG: ApiConfig = {
  baseUrl: 'https://datalaag.valeros.nl/v1', // Change this to your data layer URL
};

Running the Application

Start the development server:

bash
npm start

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

Released under the EUPL-1.2 License.