Tutorial

This tutorial shows the key functionalities of the Data Documentation UI and how to build it locally. The UI of Data Documentation Engine can be found here : https://data-doc-hub-ui.aidapt.s5projects.eu/

Basic understanding

The UI of Data Documentation Engine displays a list of datasets and their metadata. The list display allows for further filtering of datasets using facets on the left side. There is also a text search that allows for easy finding of datasets.

SearchPage

You can click on each dataset to view more details, such as the distributions and additional metadata information. Here, you can download distributions, view data valuations or delete the dataset.

DetailsPage

Local Setup

Prerequisites

  • Node.js 20+

  • pnpm 9+

  • Git

Setup

git clone https://gitlab.com/aidapt/data-documentation/data-documentation-frontend.git
cd data-documentation-frontend
pnpm install
pnpm dev

Next Steps