Skip to content
ExplorVizPublic

About

Frontend for the ExplorViz software visualization tool.

Topics

Resources

Stars

6 stars

Watchers

2 watching

Forks

Latest commit

 

History

7,004 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ExplorViz

ExplorViz is a software visualization as a service approach that researches how to facilitate program comprehension via collaboration, device-heterogenity, and different integration concepts.

Our website contains additional information such as a quickstart guide and a demo.

About this repository

This repository contains the ExplorViz frontend component. Follow the Getting started segment on our website to deploy ExplorViz or the development paragraph below to get started with frontend development.

Development

Development instructions can be found in the .dev/README file.

Container deployment

Build the production assets with pnpm install --frozen-lockfile and pnpm build, then run docker build -t explorviz/frontend:latest .. The same image can be deployed on any hostname. Production browser API URLs are relative to the current origin; nginx connects to the backend using Docker DNS names. The production environment explicitly clears development URLs so .env cannot embed localhost backend addresses in the bundle.

Use the Compose stack in the deployment repository for the complete application. For a custom container network, override the nginx upstream variables CODE_ANALYZER_URL, LANDSCAPE_SERV_URL, TRACE_SERV_URL, METRICS_SERV_URL, LOG_SERV_URL, USER_SERV_URL, VSCODE_SERV_URL, COPILOT_SERV_URL, and KEYCLOAK_URL only if their internal addresses differ from the Dockerfile defaults. Use an origin such as http://user-service:8080, without a trailing slash or path. Optional services do not have to be running for nginx to start. RESOLVER defaults to the first nameserver in the container's /etc/resolv.conf.

Set KEYCLOAK_AUTH_ENABLED=true to enable login at container startup; it defaults to false to match the deployment stack. The entrypoint writes this setting to /runtime-config.js, which loads before the application bundle. Vite development continues to use VITE_ENABLE_SKIP_LOGIN from .env. Authentication uses the current browser origin unless a Keycloak URL was explicitly supplied at build time. Configure Keycloak's public hostname and redirect URIs for your server.

For HTTPS, put a TLS reverse proxy in front of nginx, preserve Host and X-Forwarded-Proto, and enable WebSocket upgrades and SSE streaming. The site must be served at /. Share links use the current browser origin automatically. Backend CORS filtering should be disabled in a same-origin deployment, or configured separately if clients call backend ports directly.

Citation

Publications can be found on our website.

To cite ExplorViz please use:

Regression tests

Run pnpm test for the regression suite, pnpm test:watch while developing, and pnpm test:coverage for the CI coverage gate.

About

Frontend for the ExplorViz software visualization tool.

Topics

Resources

Stars

6 stars

Watchers

2 watching

Forks

Used by

Contributors

Languages