- docs/backend: admin controllers, forms, lists and filters, relation manager, users and permissions, settings, partials and widgets, admin SPA - docs/services: storage, outbound HTTP, realtime, Web Push, search, parity testing and the Frontend and AJAX (not provided) page - Examples for cabana (with testdata/docs YAML), fetchguard, lighthouse and its centrifugo driver, flare, beachcomber and typesense, tide; lighthouse and beachcomber TestDocs* regions run on their Postgres harnesses - concept map rows link their guide pages and the not-provided rows the Frontend and AJAX page; index lists Backend, Database and Services - TestDocsRequiredPages asserts the D-08 section order
22 lines
1.6 KiB
Markdown
22 lines
1.6 KiB
Markdown
---
|
|
title: SummerCMS documentation
|
|
description: SummerCMS is a content management framework for Go, inspired by WinterCMS.
|
|
section: index
|
|
order: 0
|
|
---
|
|
# SummerCMS documentation
|
|
|
|
SummerCMS keeps what makes WinterCMS productive (plugins that extend each other, YAML-driven admin forms and lists, console scaffolding) and compiles an application into a single Go binary. The framework modules, the application's plugins, the embedded admin SPA and the console commands all ship as one executable.
|
|
|
|
Start with [Installation](setup/installation.md) to set up the toolchain and the `summer` CLI. If you know WinterCMS, read [Coming from WinterCMS](setup/coming-from-wintercms.md) for a map of its concepts to SummerCMS. The API reference section has one page per framework module.
|
|
|
|
## Where to start
|
|
|
|
- [Setup](setup/introduction.md): what SummerCMS is, installation, configuration and the move from WinterCMS.
|
|
- [Architecture](architecture/introduction.md): the single binary, Go modules, the application lifecycle and the request lifecycle.
|
|
- [Plugins](plugins/registration.md): registering a plugin, scheduling, extending other plugins and testing.
|
|
- [Backend](backend/admin-controllers.md): admin controllers, forms, lists, relations, users, settings and the admin SPA.
|
|
- [Database](database/models.md): models, migrations, queries, relations, casts, attachments and transactions.
|
|
- [Services](services/configuration.md): configuration, events, routing, authentication, mail, jobs, realtime, search and the other services, plus what SummerCMS does not provide for the frontend.
|
|
- [Console](console/introduction.md): the `summer` tool, the application binary's commands and writing your own.
|