Repo content

It can be useful to familiarise yourself with the contents of a project’s Git repository before starting work on code development.

The following view should help you get started.

Directoryconfig/ // default configuration definitions
- main.yaml # CasaVue configuration file
- items.yaml # static definitions of dashboard items
Directorydeployment/ ways to deploy CasaVue
- Directorydocker-compose/ compose file for running standalone container and building static view
  - …
- Directoryhelm/ application Helm Chart
  - …
Directoryfrontend/ GUI (Vue) source files for CasaVue
- Directorysrc/
  - Directorycomponents/ // CasaVue frontend app elements
    BottomArea.vue
    colorsHandling.js
    DashBoard.vue
    ErrorBox.vue
    NamespaceItem.vue
    PWAInstallPrompt.vue
    PWAUpdatePrompt.vue
    ThemeSettings.vue
    TopArea.vue
    TopLogo.vue
  - App.vue // Frontend main source file
Directorydocs/ this docs - a standard Starlight project
- …
avatars.go // handling avatars generation for entries with no icon found
customization.go // logo generation and theme settings for PWA needs
config.go // handling configuration files
Dockerfile.distroless # Docker image definition
file_handling.go // functions for text and JSON file operations
graphics.go // logo generation for PWA needs
http_server.go // HTTP server code
icon_crawl.go // implement order of icon sources to crawl
icon_download.go // implements algorithm for obtaining icons from found icon URLs
icon_extraction.go // obtaining artifacts for dashboard items
kubernetes.go // Kubernetes integration reading Ingress resources
main.go // application starting point
models.go // data structures for dashboard items
parsing_helpers.go // helper functions for manipulating URLs
README.md
statuses.go // active HTTP checks for listed items
VERSION_APP // Single point of truth about CasaVue version
VERSION_CHART // Single point of truth about CasaVue Helm Chart version