CiviDash is an open-source sustainability dashboard for municipalities, built on Laravel (backend/admin via Filament) and Vue 3 (frontend). It supports multi-tenancy (multiple dashboards/tenants) and multilingual content (German/English), with KPI tiles, filtering, full-text search, a Filament-based page builder and data import. The related CIVITAS/CORE add-on is maintained separately.

• Repository: https://gitlab.opencode.de/regensburg_next/cividash
• Issues: https://github.com/jandaroscher/cividash/issues
• CIVITAS/CORE add-on: https://gitlab.opencode.de/regensburg_next/cividash-addon
• Installation guide: docs/deployment/installation-standalone.md
• Contributing: CONTRIBUTING.md
• Security policy: SECURITY.md

Features

• KPI tiles with time series
• Filtering by category groups
• Full-text search
• Multilingual content (German/English)
• Multi-dashboard / multi-tenancy
• Filament admin with page builder
• Data import (JSON bundles) and export (JSON/CSV)
• CIVITAS/CORE integration

Tech stack

Layer	Technology
Backend	Laravel 12, PHP 8.2, Sanctum
Admin	Filament 3.3, Filament Fabricator
Frontend	Vue 3, Vue Router 4, Pinia
Styling	Tailwind CSS 4
Build	Vite 6
Database	PostgreSQL 16
Testing	PHPUnit, Vitest, Playwright

Quickstart

Local development runs through DDEV. Node.js 20 or newer is required outside of DDEV (e.g. for editor tooling); see .nvmrc (nvm use).

ddev start                              # Start environment
ddev exec composer install              # Install PHP dependencies
ddev exec php artisan key:generate      # Generate app key (DDEV creates .env itself)
ddev exec npm install                   # Install Node dependencies
ddev exec php artisan migrate           # Run migrations
ddev exec php artisan tenancy:backfill  # Setup multi-tenancy (creates default tenant)
ddev exec php artisan db:seed           # Seed demo data (tenants, roles)
ddev exec npm run build                 # Build frontend assets (public routes need the Vite manifest)

DDEV cannot change the database engine of an existing project. On a database type mismatch, recreate the project once:

ddev delete --omit-snapshot && ddev start

Deployment

• Standalone (bare server / VM): docs/deployment/installation-standalone.md
• Docker: docs/deployment/docker.md
• CIVITAS/CORE add-on: cividash-addon, architecture in docs/architecture/civitas-core/architecture.md
• Local CIVITAS/CORE test environment: docker/civitas/README.md

See docs/deployment/README.md for the full deployment overview, including DDEV.

Hosted deployments are maintained outside this repository.

Documentation

• API documentation and the generated Scribe reference at /docs
• Architecture
• Deployment
• Testing
• Data upload
• User guide (CMS usage, German and English)
• CHANGELOG.md

Contributing

See CONTRIBUTING.md.

Privacy

CiviDash ships with no tracking out of the box: no web analytics, no tag manager, no social media plugins, no video embeds and no fonts or avatars loaded from third-party servers (the bundled fonts are served locally; tests/Feature/Privacy/NoThirdPartyHostsTest.php guards this). The public frontend sets only the two technically necessary cookies (laravel_session, XSRF-TOKEN) and uses localStorage for functional state (language, help hints), so no consent banner is required. Adding tracking is an operator decision and requires a code change; it cannot be switched on by configuration.

Security

See SECURITY.md for how to report vulnerabilities.

License

Licensed under the EUPL-1.2 or (at your option) any later version (SPDX: EUPL-1.2+). See LICENSE for the full text and NOTICE for bundled third-party components. The runtime dependencies with their licences are listed in SBOM.cdx.json (CycloneDX) and SBOM.csv.