VICAV frontend

frontend application for the VICAV project.

how to run

prerequisites:

• Node.js v22
• pnpm (corepack enable)

set required environment variables in .env.local:

cp .env.example .env.local

also, set environment variables required by GitHub actions. use "variables" for every environment variable prefixed with NUXT_PUBLIC_, and "secrets" for all others.

install dependencies:

pnpm install

run a development server on http://localhost:3000:

pnpm run dev

how to test for CI deployment

The automated build process is roughly equivalent to the following command sequence:

pnpm run build
pnpm run test
# export CI=true or
# $env:CI='true'
pnpm prune --prod
pnpm run start

If you did not actually set the environment variables in .env.local in your development environment, replace the last line with:

pnpm run start:local

This loads .env.local as environment and then executes pnpm run start.

Open the production server on http://localhost:3000 and make sure it loads and shows the new features you implemented.

If you do not verify that these commands work after major overhauls there is a high change that pnpm run dev works but the deployed container does not.

Get back dev packages:

# unset CI or
# del env:CI
pnpm prune

Release

• Checkput main branch
• Merge develop into main
• Update version in package.json (e. g. 0.8.0)
• Commit version change
• Create tag with version (e. g. v0.8.0)
• git push and git push origin --tags
• Checkout develop branch
• Merge main into develop
• Revert the commit Limit actions to production ready
• git push

Telemetry

This project is instrumented with OpenTelemetry to collect traces and metrics. You can configure the exporter endpoint via the OTEL_EXPORTER_OTLP_ENDPOINT environment variable in .env.local. See .env.example for reference.

For a local setup, you can use the Jaeger all-in-one Docker image:

docker run --rm --name jaeger \
   -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
   -p 16686:16686 \
   -p 4317:4317 \
   -p 4318:4318 \
   -p 14250:14250 \
   -p 14268:14268 \
   -p 14269:14269 \
   -p 9411:9411 \
   jaegertracing/all-in-one:latest

Then set OTEL_EXPORTER_OTLP_ENDPOINT=http://127.0.0.1:4317 in your .env.local file.