5b09b32512
- stderr and null drivers; per-component levels from log.components - SUMMER_LOG__ overrides parse as strings and overlay the defaults key by key - Validation names the key: driver, format, level, days, stack children and cycles, daily path outside the root - summer new writes config/log.yaml (stack of console and daily, river warn, http info) - docs/services/logging.md: channels, config/log.yaml, component loggers, daily files, redaction - Log keys in the configuration docs; ExampleFor backs the docs snippet
57 lines
3.5 KiB
Plaintext
57 lines
3.5 KiB
Plaintext
# CLAUDE.md
|
|
|
|
Guidance for AI coding agents working in this repository. `AGENTS.md` is a symlink to this file.
|
|
|
|
## What this is
|
|
|
|
`sm-demo-app` is a SummerCMS application: a Go program built on the SummerCMS framework, module `git.golem15.com/golem15/summercms`. `go.mod` replaces the framework with the local checkout at `../summercms`. That checkout is shared with every other application next to it: do not edit the framework from here. Change this application, or report the framework problem.
|
|
|
|
Framework documentation for agents:
|
|
|
|
- https://summercms.io/docs/llms.txt (index)
|
|
- https://summercms.io/docs/llms-full.txt (full text in one file)
|
|
|
|
## Commands
|
|
|
|
Run them from this directory.
|
|
|
|
```sh
|
|
docker compose up -d --wait # start PostgreSQL 16 on 127.0.0.1:54320
|
|
summer build # generate main.go and plugins.gen.go, build bin/demo
|
|
summer dev # watch sources and rebuild
|
|
summer migrate # run plugin migrations
|
|
summer serve # start the HTTP server
|
|
summer make:plugin golem15.<name> # scaffold a plugin module under plugins/<name>
|
|
summer plugin:add plugins/<name> # register it in summer.yaml, go.mod and go.work
|
|
summer make:admin-controller golem15.<plugin> <Name> # scaffold an admin controller with its YAML
|
|
summer admin:create --email you@example.com --superuser # create a backend administrator (password prompted)
|
|
```
|
|
|
|
## Layout
|
|
|
|
- `summer.yaml`: the application manifest (module path, binary name, ordered plugin list).
|
|
- `plugins/`: local plugin modules. `plugins/demo` is the starter plugin `golem15.demo`; its `routes.go` answers `GET /` with JSON.
|
|
- `config/`: YAML configuration (`app.yaml`, `database.yaml`, `http.yaml`, `log.yaml`, `storage.yaml`). Any key can be overridden with a `SUMMER_` environment variable, a double underscore separating path segments (`SUMMER_DATABASE__DSN` sets `database.dsn`).
|
|
- `.env`: local secrets (database DSN, application key, admin token secret). Never commit it; `.gitignore` excludes it. `.env.example` lists the variables.
|
|
- `compose.yaml`: the local PostgreSQL 16.
|
|
- `main.go`, `plugins.gen.go`: generated by `summer build` from `summer.yaml`. Do not edit them by hand; they are committed.
|
|
- `go.work`: the workspace that joins the application and its plugin modules.
|
|
|
|
Plugins are Go modules compiled into the binary at build time; there is no runtime plugin loading. Add a plugin with `summer make:plugin` and `summer plugin:add`, then run `summer build`.
|
|
|
|
## Admin
|
|
|
|
The backend admin (the admin SPA and its JSON API) lives under `/backend`, at `http://127.0.0.1:8080/backend` with the default `summer serve` address. It is mounted only when a plugin registers an admin controller; until then `summer serve` prints `admin: off`. To add it:
|
|
|
|
1. `summer make:admin-controller golem15.<plugin> <Name>` scaffolds the controller and its YAML. The generated controller requires the permission `golem15.<plugin>.access_<name>` (`<name>` is the controller name in snake case): declare it in the plugin's `Permissions()` (`pact.HasPermissions`) or the admin refuses to start. Its `NewRecord` returns `nil` until you return the plugin's model.
|
|
2. `summer build`, then `summer migrate`.
|
|
3. `summer admin:create --email you@example.com --superuser` creates the first administrator; the password is prompted.
|
|
|
|
`.env` already holds `SUMMER_ADMIN__JWT__SECRET`, which signs admin tokens.
|
|
|
|
## Naming convention
|
|
|
|
- `sm-<name>-app`: an application, like this repository.
|
|
- `sm-<name>-plugin`: a standalone plugin module.
|
|
- `sm-<name>-theme`: a Nuxt/Vue frontend.
|