Skip to content

Latest commit

 

History

History
99 lines (64 loc) · 2.99 KB

README.md

File metadata and controls

99 lines (64 loc) · 2.99 KB
Raw

museumsbahn-events

This is the code behind the page museumsbahn-events.at which will be launched in the first half of 2024.

Goal

The goal of the museumsbahn-events plattform is to crawl events from all associations across Austria which are involved in preserving and running heritage trains.

The main idea is that this project does not cause any additional work for the associations, but gives a single point of entry for people who are planning their next trips and want to know which events are happening.

Architecture

As a central hub we use boudicca.events and the eventdb provided by boudicca. We implemented some custom eventcollectors, which are fully compatible with boudicca.

Additionally we use a separate backend to provide additional information like museum locations, opening hours, contact details and so on.

Current Limitations

Development

Requirements

  • npm
  • java21
  • gradle

It's recommended to use IntelliJ or VsCode as IDE. Nuxt support in both is unfortunately not great.

Publish artifacts to private repos

This setup is necessary once in order to be able to publish to private repos

Modifying the API and releasing a new version

  1. bump the version in build.gradle.kts
  2. modify the kotlin api in museum-railway-api
  3. adapt and start the backend
  4. find the openapi.yaml at http://localhost:8080/v3/api-docs.yaml
  5. copy the contents to museum-railway-web/src/main/resources/museum-railway-backend.yaml
  6. run generateTypescriptClient

in the generated typescript client follow the README.md, but generally you can run

npm install
npm run build
npm publish

for dry run you can use

npm publish --dry-run

Local Store File

When running EventDB with the supplied docker-compose it saves its data into the file boudicca.store in the boudicca.store/ folder of the project. So if you want to clean the EventDB, stop it, delete the file and restart it.

Deployment

The best way to deploy is to use a docker compose

generate signing keys for imgproxy

If you need a random key/salt pair in a hurry, you can quickly generate one using the following snippet:

echo $(xxd -g 2 -l 64 -p /dev/random | tr -d '\n')

for details see: https://docs.imgproxy.net/configuration/options#url-signature

GDPR conforming matomo configuration

https://matomo.org/faq/how-to/how-do-i-configure-matomo-without-tracking-consent-for-french-visitors-cnil-exemption/

https://matomo.org/wp-content/uploads/2021/10/Matomo-Analytics-Exemption-from-Tracking-Consent-in-France-CNIL.pdf

https://matomo.org/faq/general/configure-privacy-settings-in-matomo/

https://matomo.org/faq/how-to/how-do-i-enforce-tracking-without-cookies/

How do I go cookieless (disable all cookies) for a visitor?

https://matomo.org/faq/general/faq_157/

Checklist

  • have user opt out
  • Automatically Anonymise Visitor IPs and replace User IDs
  • use anonymized IP for geolocation
  • have no user id / no login
  • regularly delete old raw visitor data - 90 days
  • delete old aggregated report data - 6 months