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.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

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/de.json
2. Reference it inside the Component with t('your.key') after importing t from useI18n()