github.com/kyleu/dbaudit@v0.0.2-0.20240321155047-ff2f2c940496/doc/module/core.md (about)

     1  <!--- Content managed by Project Forge, see [projectforge.md] for details. -->
     2  # Core
     3  
     4  This is a module for [Project Forge](https://projectforge.dev). It provides common utilities for a Go application.
     5  
     6  https://github.com/kyleu/projectforge/tree/master/module/core
     7  
     8  ### License
     9  
    10  Licensed under [CC0](https://creativecommons.org/publicdomain/zero/1.0)
    11  
    12  ### Packages
    13  
    14  See `customizing.md` for details
    15  
    16  - `cmd` contains the main CLI actions
    17  - `controller` contains HTTP actions for the server UI, see [faq.md](../faq.md) for details
    18  - `lib/filter` is used by the UI for sorting and filtering
    19  - `lib/log` contains custom zap loggers and appenders
    20  - `lib/menu` is used by the UI to draw the left nav and breadcrumbs
    21  - `lib/telemetry` allows tracing via OpenTelemetry and metrics via Prometheus, used everywhere
    22  - `lib/theme` contains UI themes for controlling the UI look and feel
    23  - `lib/user` defines user, accounts, and permissions
    24  - `util` contains dozens of useful helper functions