Skip to content

architecture.md

Latest commit

 

History

History
74 lines (55 loc) · 2.34 KB

architecture.md

File metadata and controls

74 lines (55 loc) · 2.34 KB

Architecture

This chapter provides a high-level overview of the Folio Rails Engine architecture, including its main models, relationships, and key data flows. Use this as a reference for understanding how the engine is structured and how its core components interact.

Engine Structure

Folio is a modular CMS engine for Ruby on Rails, designed for extensibility and maintainability. It provides:

  • A flexible content model based on Atoms and Pages
  • A modern admin interface (Console)
  • File and media management
  • User and site management
  • Extensible ViewComponent-based UI

Main Models and Relationships

Below is a simplified diagram of the main models and their relationships in Folio:

classDiagram
    Site <|-- Page
    Site <|-- User
    Page "1" o-- "*" Atom : has many
    Page "1" o-- "*" FilePlacement : has many
    FilePlacement "*" o-- "1" File : belongs to
    User <|-- SiteUserLink
    Page o-- Menu : navigation
    File <|-- MediaFile
    User <|-- NewsletterSubscription
Loading

Legend:

  • Site — Represents a website or subsite
  • Page — Content page, composed of Atoms and Files
  • Atom — Content block (text, image, video, etc.)
  • File — Uploaded file or media asset
  • User — User account
  • Menu — Navigation structure
  • FilePlacement — Placement of a file on a page
  • NewsletterSubscription — Newsletter signup
  • SiteUserLink — User-to-site relationship

Key Data Flows

Content Rendering

  • Pages are composed of Atoms (content blocks) and Files (media)
  • Atoms are rendered using ViewComponents for flexibility and reusability
  • Menus and navigation are managed via Menu and MenuItem models

File Upload & Management

  • Files are uploaded via the admin console or public forms
  • FilePlacements associate files with pages or atoms
  • Metadata is extracted and stored for each file

User & Site Management

  • Users can belong to one or more Sites via SiteUserLink
  • User roles and permissions are managed in the admin console

Navigation

For more details, see the individual chapters linked above. This architecture overview will be updated as the documentation evolves.