README.md

ExplorViz Deployment Repo

This repo contains different

• A Docker-Compose stack to start ExplorViz with all its components.
• A backend and application substitute, convenient for frontend development (demo-supplier).
• A frontend-demo Docker-Compose stack to start the ExplorViz frontend with the backend substitute and application substitute.
• A vs-code-demo Docker-Compose stack to start a browser-based VS Code with the ExplorViz VS code extension and the frontend-demo stack.
• Sample applications with instrumentation and Docker-Compose files.

Caveats for Windows

• Be sure to use LF (not CRLF!) for line endings. Otherwise, scripts such as the Docker entry point for Cassandra may fail.

Pre-Commit Validation

The CI pipeline for this repository uses pre-commit with different hooks to validate if changes to files follow well-defined rules.

You can locally validate all files, therefore simulate the CI pipeline, with

docker run --rm -ti -v $(pwd):/pre-commit explorviz/pre-commit

The resulting container will run the defined pre-commit hooks and also modify files if necessary. You might need to run this command multiple times.