53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
**SummerCMS** is a planned rewrite of WinterCMS/OctoberCMS in Scala. The goal is to create a similar Content Management Framework (CMF) with improved performance and stability.
|
|
|
|
### Project Status
|
|
|
|
This is a **greenfield project**. The repository currently contains:
|
|
- `golem15-wintercms-starter/` - Git submodule of the existing WinterCMS implementation (reference)
|
|
- `IDEA.md` - High-level requirements and vision
|
|
|
|
### Core Requirements (from IDEA.md)
|
|
|
|
1. **Model/Controller/Components system** - Similar to WinterCMS patterns
|
|
2. **Modern frontend-backend communication** - Replace AJAX with efficient, scalable framework
|
|
3. **Admin backend** - YAML/JSON-driven form generation
|
|
4. **CLI scaffolding** - Console commands for initial setup
|
|
5. **Plugin/Theme system** - Extensible architecture with plugin interdependencies
|
|
|
|
## Reference Implementation
|
|
|
|
The WinterCMS reference is in `golem15-wintercms-starter/`. See its `CLAUDE.md` for details on:
|
|
- Golem15 plugin architecture
|
|
- Apparatus framework (DI, scenarios, form widgets)
|
|
- PaymentGateway FSM patterns
|
|
- User/Auth with JWT
|
|
- Translation system
|
|
|
|
### Key WinterCMS Patterns to Replicate
|
|
|
|
**Plugin Structure:**
|
|
- Controllers, Models, Components in plugin root
|
|
- YAML-based form fields and list columns (`fields.yaml`, `columns.yaml`)
|
|
- Plugin dependencies via `$require` arrays
|
|
- Event-driven model extensions
|
|
|
|
**Apparatus Framework Concepts:**
|
|
- Scenario-based workflow engine
|
|
- Automatic dependency injection for components
|
|
- Backend CSS/JS injection system
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# Initialize submodules (to access reference implementation)
|
|
git submodule update --init --recursive
|
|
```
|
|
|
|
Future Scala project setup will be documented here once the build system is established.
|