Development¶

Development Environment¶

It is highly recommended to use Visual Studio Code for working on the Open Data Dashboard. The project contains useful preset VSCode settings that will be applied once you open the project. Additionally, make sure to install the recommended extension.

Application¶

To start developing the Open Data Dashboard Next.js application, make sure you have Node.js installed on your system.

Now, you can run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Useful commands:

Run Next.js development server

npm run dev

Lint code (ESLint)

npm run lint

Execute tests

npm test

Validate configuration files

npm run test:config-validation

Build application

npm run build

Run production build locally

npm run start

Resources:

Next.js Documentation

Documentation¶

To start developing the Open Data Dashboard MkDocs documentation, make sure you have Python3.12 installed on your system.

First, set up your virtual environment and install the required dependencies:

Setup and installation (Linux)

python -m venv docs/.venv
source docs/.venv/bin/activate
pip install -r docs/requirements.txt

Setup and installation (Windows)

python -m venv docs/.venv
./docs/.venv/Scripts/activate.bat
pip install -r docs/requirements.txt

Now, you can run the MkDocs development server:

npm run docs

Open http://localhost:8000 with your browser to see the result.

Useful commands:

Start the live-reloading docs server

npm run docs

Build the documentation site

mkdocs build

Resources: