acdh-oeaw / vicav-vue3

Reimplementation of the VICAV Frontend based on Vue.js 3
https://vicav-vue.acdh-ch-dev.oeaw.ac.at
MIT License
0 stars 0 forks source link

VICAV frontend

frontend application for the VICAV project.

how to run

prerequisites:

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