Skip to content

project-structure.md

Latest commit

 

History

History
102 lines (93 loc) · 3.34 KB

project-structure.md

File metadata and controls

102 lines (93 loc) · 3.34 KB
Raw

Project Structure

There are two separate directories: the CMS source (this repo) and user sites.

CMS Source (this repo — immutable)

Users never edit these files. This is the Publr core.

publr/
├── build.zig              # Zig build configuration
│
├── src/
│   ├── main.zig           # Entry point, CLI
│   ├── http.zig           # HTTP server, router, WebSocket
│   ├── db.zig             # SQLite wrapper
│   ├── auth.zig           # Sessions, password hashing
│   ├── cms.zig            # Content types, entries
│   ├── media.zig          # Upload, resize, serve
│   ├── api.zig            # JSON API handlers
│   ├── plugin.zig         # Plugin interface definition
│   │
│   ├── cli/               # CLI commands
│   │   ├── init.zig       # `publr init`
│   │   ├── serve.zig      # `publr serve`
│   │   ├── build.zig      # `publr build`
│   │   └── plugin.zig     # `publr plugin add/remove/list`
│   │
│   ├── templates/         # Admin UI (Zig)
│   │   ├── layout.zig
│   │   ├── entries.zig
│   │   ├── media.zig
│   │   └── types.zig
│   │
│   ├── blocks/            # Phase 2
│   │   ├── block.zig
│   │   ├── paragraph.zig
│   │   ├── heading.zig
│   │   └── image.zig
│   │
│   ├── rtc/            # Phase 3
│   │   ├── websocket.zig
│   │   ├── ot.zig
│   │   └── presence.zig
│   │
│   └── build/             # Phase 4
│       ├── parser.zig     # .publr template parser
│       ├── generator.zig  # Static site generator
│       └── assets.zig     # Asset pipeline
│
├── static/
│   ├── admin.js
│   ├── admin.css
│   └── editor.js          # Phase 2: Block editor
│
└── vendor/
    ├── sqlite3.c
    ├── sqlite3.h
    ├── stb_image.h
    ├── stb_image_resize2.h
    └── stb_image_write.h

User Site (created via publr init my-site)

This is what users create and manage. They use CLI commands, never touch source.

my-site/
├── publr.zon                # Site config + plugin list
│
├── plugins/                 # Downloaded plugins (like node_modules)
│   ├── code-field/
│   │   ├── plugin.zig
│   │   └── ...
│   └── webhook/
│       └── plugin.zig
│
├── themes/                  # Site templates (.publr files)
│   └── default/
│       ├── layouts/
│       │   └── base.publr
│       ├── pages/
│       │   ├── index.publr
│       │   └── [slug].publr
│       └── components/
│           └── header.publr
│
├── data/
│   └── publr.db             # SQLite database
│
└── .publr/                  # Auto-generated (gitignored)
    └── plugins.zig          # Generated plugin imports

Key Files to Understand

  1. src/main.zig — Start here. CLI parsing, server init.
  2. src/http.zig — Router implementation, middleware pattern.
  3. src/db.zig — SQLite bindings, query helpers.
  4. src/templates/entries.zig — Example of HTML generation pattern.
  5. static/admin.js — All frontend interactivity.