Skip to content

acdh-oeaw/youbeon-frontend

Repository files navigation

YouBeOn

Web frontend for the YouBeOn - Young Believers Online project.

Deployed at https://app.youbeon.eu.

Temporarily deployed to https://youbeon-frontend.acdh-ch-dev.oeaw.ac.at, because the youbeon.eu domain has expired.

Made with Vue, built with Vite.

Prerequisites

Install Node.js v16, and install project dependencies with:

npm install

This will also generate (i) the JSON "database" in the src/db folder from .xlsx files in the data folder, (ii) generate an imprint page, and (iii) generate favicons.

How to run

Run a development server with:

npm run dev

Preview a production build locally with:

npm run build && npm run preview

Deployment

A GitHub action is triggered on every push to the main branch, which builds a new Docker image, and notifies rancher to deploy that image to the ACDH-CH cluster.

Validation

Validation scripts for code formatting (prettier), linting (eslint and stylelint), and type checking (typescript) run as pre-commit and pre-push git hooks.