Open Source Facility Management Software (Frontend)

remsfal-frontend is a single-page application (SPA) built using Vue 3 in Vite to manage real estate projects. It works together with the remsfal-backend repository.
You can see a live version at https://remsfal.de.

Architecture & Conventions

Before contributing, read AGENT.md — it documents the project architecture, coding conventions, API patterns, and everything else you need to know to work effectively in this codebase.

Recommended IDE Setup

VSCode + Volar (and disable Vetur).

TypeScript support for .vue files is handled by vue-tsc. Volar provides the necessary language service integration — no additional TypeScript plugin is required.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint

Lint with Stylelint

npm run stylelint

Service Worker

The Service Worker is disabled by default in the local development environment to ensure that code changes are reflected immediately without caching issues.

To enable and develop the Service Worker locally, set the following variable in your .env file:

VITE_SERVICE_WORKER_ENABLED=true

Translate with vue-18n

The default language is set to German with English as the fallback Language

Hint: Use i18n-ally with VS Code

Steps:

1. Create a translation key in src/i18n/locales/de.json and src/i18n/locales/en.json
2. Reference it inside the Component with t('your.key') after importing t from useI18n()