The TypeScript code powering the TEDective UI

Go to file

Linus Sehn c588951ff4 All checks were successful continuous-integration/drone/push Build is passing Details fix: change inital org ID		2024-06-17 21:19:14 +02:00
__tests__	#8 #13 #30 #37	2023-12-12 16:09:38 +01:00
components	feat: adapted UI to allow date filtering	2024-05-29 02:00:13 +02:00
lib	feat: add tailwind and shadcn	2024-04-06 14:55:47 +02:00
pages	feat: adapted UI to allow date filtering	2024-05-29 02:00:13 +02:00
public	feat: remove cache and other legacy components	2024-04-06 14:57:18 +02:00
styles	feat: adapted UI to allow date filtering	2024-05-29 02:00:13 +02:00
.dockerignore	working docker	2023-08-16 13:12:16 +02:00
.drone.yml	feat: add deployment files	2023-08-23 07:27:27 +02:00
.env	fix: change inital org ID	2024-06-17 21:19:14 +02:00
.eslintrc.json	Initial commit	2023-08-15 15:12:24 +02:00
.gitignore	feat: add tailwind and shadcn	2024-04-06 14:55:47 +02:00
components.json	feat: add tailwind and shadcn	2024-04-06 14:55:47 +02:00
docker-compose.yml	feat: switch to apex domain	2024-04-06 15:45:42 +02:00
Dockerfile	feat: add deployment files	2023-08-23 07:27:27 +02:00
LICENSE	Initial commit	2023-08-14 14:42:26 +00:00
next.config.js	feat: add tailwind and shadcn	2024-04-06 14:55:47 +02:00
package.json	feat: adapted UI to allow date filtering	2024-05-29 02:00:13 +02:00
pnpm-lock.yaml	feat: adapted UI to allow date filtering	2024-05-29 02:00:13 +02:00
postcss.config.js	feat: add tailwind and shadcn	2024-04-06 14:55:47 +02:00
README.md	feat: switch to apex domain	2024-04-06 15:45:42 +02:00
tailwind.config.js	feat: add tailwind and shadcn	2024-04-06 14:55:47 +02:00
tsconfig.json	feat: add tailwind and shadcn	2024-04-06 14:55:47 +02:00

README.md

TEDective UI

Interactive visualization tool for exploring graph data from the TEDective API.

This project houses the TypeScript code that powers the TEDective UI, an interactive visualization tool for exploring graph data fetched from the TEDective API. The UI leverages the capabilities of various libraries to create a compelling user experience. Part of TEDective Project.

This project is implemented using Next.js, react-force-graph, d3-force, Leva GUI, Chart.js, and Leaflet.

TEDective UI

Features

The TEDective UI boasts the following features:

Fetches graph data from the TEDective API
Displays an interactive 2D force graph using react-force-graph and d3-force
Utilizes Next.js for server-side rendering and enhanced performance
Integrates Leva GUI for a user-friendly graphical user interface to tweak parameters
Incorporates Chart.js for generating data-driven charts
Includes Leaflet for interactive maps
Is guided by a Intro.js tour
Test-driven by Jest.js

Background

The TEDective project aims to make European public procurement data from Tenders Electronic Daily (TED) explorable for non-experts. This repository contains the TypeScript code powering the TEDective UI.

Part of TEDective Project

Getting Started

Installation

To get started with the TEDective UI locally, follow these steps:

Clone this repository
Navigate to the project directory
Install the dependencies: pnpm install
Start the development server: pnpm run dev
Access the UI in your browser at http://localhost:3000

Install with Docker

To run the TEDective UI using Docker, use the following commands:

Build the Docker image: docker build -t tedective-ui .
Run the Docker container: docker run -p 3000:3000 tedective-ui

For detailed installation instructions please refer to the TEDective documentation.

Environment configuration

The .env file is commonly used to store environment variables for your application. Environment variables are key-value pairs that configure how your application behaves in different environments. You will find this file in the root directory of the project.

Usage

You can find more information in the user documentation.

Maintainers

@linus @siemer

Contributing

PRs are accepted and very much welcomed.

Small note: If editing the README, please conform to the standard-readme specification.