frontend for viecpro.
prerequisites:
Tip
you can use pnpm to install the required node.js version with pnpm env use 22 --global
set required environment variables in .env.local:
cp .env.local.example .env.localalso, set environment variables required by validation and
deployment github actions. use
"variables" for every
environment variable prefixed with NEXT_PUBLIC_, and
"secrets" for all others.
NEXT_PUBLIC_REDMINE_ID(required): service issue for this application in the acdh-ch redmine issue tracker.NEXT_PUBLIC_APP_BASE_URL(required): the base url for this application. the default of "http://localhost:3000" should be fine for local development.NEXT_PUBLIC_BOTS(required): whether this website can be indexed by web crawlers like the google bot. supported values are "disabled" and "enabled", defaults to "disabled".NEXT_PUBLIC_MATOMO_BASE_URLandNEXT_PUBLIC_MATOMO_ID(optional): set these to support client-side analytics with matomo.NEXT_PUBLIC_GOOGLE_SITE_VERIFICATION(optional): set this to verify site ownership for google search console.ENV_VALIDATION(optional): whether to validate environment variables. supported values are "disabled", "enabled", and "public". defaults to "enabled". "public" only validates build-args prefixed withNEXT_PUBLIC_, which can make sense in a docker build context.
when adding new environment variables, don't forget to add them to
.env.local.example and config/env.config.ts as
well.
install dependencies:
pnpm installrun a development server on http://localhost:3000:
pnpm run devTip
this repository supports developing in containers. when opening the project in your editor, you should be prompted to re-open it in a devcontainer.
generate a production build and run end-to-end tests with:
pnpm run build
pnpm run test:e2evisual snapshot tests should be run in the repository's devcontainer - or a comparable debian bookworm based linux environment -, and can be updated with:
pnpm run test:e2e:update-snapshots