golem15/summercms
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add a name mnemonic to every module README and the root modules table

Browse Source
This commit is contained in:
Jakub Zych
2026-10-11 00:26:20 +02:00
parent 5e3c552aa1
commit ca1443e9c8
25 changed files with 74 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/lagoon/README.md
View File

@@ -6,6 +6,8 @@ Postgres data layer: the shared GORM connection, per-plugin migrations, model he
`import "git.golem15.com/golem15/summercms/modules/lagoon/attach"`
**Name:** Calm, deep water where everything settles; it is the database layer where data is stored.
## Overview
`lagoon` is the WinterCMS models and migrations counterpart: it opens the one `*sql.DB` pool (pgx stdlib driver) that GORM and the rest of the application share, runs each plugin's gormigrate set in its own history table, and ports the Eloquent model conventions that WinterCMS plugins rely on, such as `$fillable`, `$hidden`, `$jsonable`, encrypted casts and Laravel-style validation rules. Its `attach` subpackage ports WinterCMS's `system_files` attachments, storing originals and lazily generated thumbnails in a gocloud.dev blob bucket. The application binary gets the migrate and key commands from `lagoon.RuntimeCommands`.