Skip to content

EVERSE-ResearchSoftware/DashVERSE

Repository files navigation

DashVERSE

The dashboard prototype for the EVERSE project.

Warning

🚧 Work in Progress

This project is currently under active development and may not yet be fully stable. Features, functionality, and documentation are subject to change as progress continues.

We welcome feedback, contributions, and suggestions! If you encounter issues or have ideas for improvement, please feel free to open an issue or submit a pull request.

Requirements

  • Python (3.12)
  • Poetry (1.8.5)
  • Docker (27.4.1)
  • minikube (v1.34.0)
  • helm (v3.16.4)
Links for the requirements

Python

https://www.python.org/downloads

Pyenv (optional)

Pyenv allows developers to install multiple versions of Python distribution and easy switching between the installed versions.

Website: https://github.com/pyenv/pyenv?tab=readme-ov-file#installation

Poetry (optional)

Poetry is used for dependency management of the Python packages.

https://python-poetry.org/docs/#installation

Docker

https://docs.docker.com/engine/install

minikube

https://minikube.sigs.k8s.io/docs/start

helm

https://helm.sh/docs/intro/install

Step-1 Setting up a Kubernetes Cluster

This step will set up a Kubernetes cluster using minikube. The kubernetes cluster will be deployed using Docker driver. For the alternative drivers have a look at this link.

Check versions

$ minikube version
minikube version: v1.34.0
commit: 210b148df93a80eb872ecbeb7e35281b3c582c61
$ kubectl version --client
Client Version: v1.31.1
Kustomize Version: v5.4.2

Start the cluster

minikube start --driver=docker

Step-2 Deploy a Superset instance

  • Add the Superset helm repository

    helm repo add superset https://apache.github.io/superset
  • View charts in repo

    helm search repo superset
  • Install and run

    helm upgrade --install --values dashverse-values.yaml superset superset/superset
  • Create a tunnel between the superset pod and your localhost

    kubectl port-forward service/superset 8088:8088 --namespace default

Testing

API endpoints

Thedocumentation for the API is at http://localhost:8088/swagger/v1

Clean up

The command below will remove the kubernetes cluster and purge all the data.

minikube stop
minikube delete --purge --all

About

A dashboard prototype.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages