Skip to content

README.md

Latest commit

 

History

History
executable file
·
144 lines (121 loc) · 5.76 KB

README.md

File metadata and controls

executable file
·
144 lines (121 loc) · 5.76 KB
Raw

Feather CMS 🪶

⚠️ ⚠️ ⚠️ !WORK IN PROGRESS! ⚠️ ⚠️ ⚠️

🪶 Feather is a modern Swift-based Content Management System.

💬 Click to join the chat on Discord.

Make Commands

Run these from the repository root:

  • make clean Clears only the Postgres database volume and media storage volume.
  • make reset Drops the full Compose stack, including all Compose-managed volumes.
  • make stop Stops all running services without removing them.
  • make deps Builds and runs the current dependency services: certificates, postgres, and migrator.
  • make backend Builds and runs the backend stack: dependencies plus server and worker.
  • make all Builds and runs the full local stack. For the web app, this also sets browser-facing public origins for: WEB_PUBLIC_BASE_URL, STATIC_PUBLIC_BASE_URL, and MEDIA_PUBLIC_BASE_URL. By default, make all and make all-up try to detect the current LAN IP and use: http://<ip>:3456, http://<ip>:4567, and http://<ip>:8080. If LAN detection fails, Compose falls back to the localhost defaults. You can override any of them explicitly, for example: WEB_PUBLIC_BASE_URL=http://192.168.8.102:3456 STATIC_PUBLIC_BASE_URL=http://192.168.8.102:4567 MEDIA_PUBLIC_BASE_URL=http://192.168.8.102:8080 make all
  • make clean all Clears database and media storage, then builds and runs the full stack.
  • make clean backend Clears database and media storage, then builds and runs the backend stack.

Public Origin Variables

These variables control browser-facing URLs and are separate from the internal API_BASE_URL used by the web app to talk to the backend service.

  • WEB_PUBLIC_BASE_URL Public base URL for the web/admin app, for example http://localhost:3456.
  • STATIC_PUBLIC_BASE_URL Public base URL for static assets, for example http://localhost:4567.
  • MEDIA_PUBLIC_BASE_URL Public base URL for backend-served media assets, for example http://localhost:8080.

Compose defaults:

  • WEB_PUBLIC_BASE_URL=http://localhost:3456
  • STATIC_PUBLIC_BASE_URL=http://localhost:4567
  • MEDIA_PUBLIC_BASE_URL=http://localhost:8080

Todos

  • hook functions for modules -> asset deletion should trigger hook (remove related assets)
  • email template system -> send out emails
  • content editor for web-based contents
  • required relations, autocomplete fixes (require N item)
  • multiple selection for gallery picker -> video picker, file picker, etc.
  • review migrations
  • fix required labels design
  • split openapi into modules
  • cleanup css setAttribute calls
  • review architecture boundaries (frontend, backend)
  • check screens on mobile

User module

  • user invitation should have role(s)
  • current signed in user should have a profile picture
  • user accounts should be just an identifier?
  • auth magic link should have an user id? (or user selector)
  • there should be an email + passsword menu under auth? Credentials?
  • user account = id + email? + profile picture?
  • user account filter by role(s)
  • user email + password should be a different table?
  • user magic link sign in should be a different table?
  • user settings + profile settings should work
  • root role & root user should be permanent. (no deletion)
  • invitation should use an email template
  • invitation links should work
  • magic links should work
  • user session should store device or some extra information
  • how to extend user data with additional fields? e.g. first name, last name, etc.
  • settings to enable different login methods (credentials, magic links, social, etc.)
  • oauth2 + oidc support
  • Sign in with Apple support
  • Sign in with Google support
  • Sign in with Meta support
  • Sign in with Auth0 support?

Redirect module

  • 404 items should have a create redirect button to simplify redirect creation
  • redirect rules should have match count and last matched timestamp

Analytics module

  • should parse user agent header and display bot & crawler traffic
  • should hide / redact bearer token information & sensitive data

Web module

  • should have drag & drop option for menu items (instead of priority field)
  • should have permission picker instead of manual permission input
  • should hide metadata menu item? or find a purpose for it?
  • should use web settings to set logo, colors, etc.

Blog module

  • add post, tag, author slug vs edit slug UI is inconsistent
  • blog author vs user account relation?

UI

  • multi asset (image) / gallery support for models
  • proper detail page for all the models (now it's too rough / raw)
  • proper date picker field for publication date & time
  • limit selection field by X amount of items
  • should come up with better UI for Metadata, social & advanced (sidebar?)
  • better UI for media asset upload (segmented control vs same page)
  • popup for adding simple models?
  • coordinate picker / location support
  • multi-field support? repeat X elements on the same page?
  • markdown editor for content
  • rich editor for web pages / content?
  • slider, color picker, etc.
  • better confirmation dialogs?

General

  • nonce support for CSRF protection
  • consider using Postgres instead of Valkey for jobs
  • consider using SQLite as primary database? (jobs issue?)
  • split web frontend by modules
  • proper mustache rendering with context & pipeline

Contact module

  • form support?
  • newsletter support?

OpenAPI Generator

The Swift OpenAPI generator package lives at openapi-generator. Use make -C openapi-generator yaml or make -C openapi-generator run to regenerate the OpenAPI YAML and generated Swift sources in openapi.