Skip to content

Complete setup scripts and document content generation and publishing - #241

Open
m0shiurX wants to merge 1 commit into
HarunRRayhan:mainfrom
m0shiurX:codex/setup-and-usage-guide
Open

m0shiurX wants to merge 1 commit into
HarunRRayhan:mainfrom
m0shiurX:codex/setup-and-usage-guide

Conversation

@m0shiurX

Copy link
Copy Markdown

Summary

A fresh checkout currently leaves account creation and content workers undocumented, and rerunning composer run setup replaces APP_KEY. That can make saved integration credentials unreadable. This change makes local setup preserve existing keys and starts the full content workflow through composer run dev.

composer run setup
  install locked dependencies
  preserve or initialize APP_KEY
  migrate and create ADMIN_EMAIL if configured
  build assets

composer run dev
  server, Vite, logs
  default, scratchpad, and publishing workers
  scheduler

composer run setup:production
  install production PHP dependencies
  require a provisioned APP_KEY
  build assets
  run existing cm:deploy steps and optimize

Add supervised worker commands and a production guide covering the first owner account, persistent uploads, process placement, and repeat releases. Expand the README with integration setup, Telegram generation and approval, scheduling, video publishing, API/MCP access, and seeded-account dashboard recovery. Keep the updated documentation consistent and use plain punctuation.

Evidence

  • Before: setup unconditionally called key:generate; the development process list omitted scratchpad, publishing, and scheduling.
    After: five focused tests pass with 17 assertions, covering key preservation, first local generation, production refusal without a key, and development worker registration.
  • composer validate --strict, Pint, PHPStan, Composer audit, frontend lint/format/type checks, and the Vite production build pass. Local documentation links and embedded PHP syntax also pass.
  • Full local PostgreSQL run: 1,303 tests, 1,235 passed, 53 failed, and 15 errors. A separate checkout of unchanged upstream 52a8df0 produces 1,298 tests, 1,230 passed, the same 53 failures, and 15 errors. Those baseline failures are in existing publishing, token migration, and Telegram tests; this PR adds five passing tests. Both runs used a disposable database, not the operator database.
  • The combined production setup has not been run against a live deployment. The existing Railway Docker build and cm:deploy release hook remain in place.

Merge Danger

Door: two-way

The code and documentation can be reverted. Existing keys are preserved; no migrations are added or changed. The new production setup command invokes the existing deployment operations only when explicitly run.

Blast Radius: setup

composer run dev now processes pending publishing jobs as part of the complete local workflow. Production operators still need a supervisor, shared persistent uploads for the media workers, and a single scheduler. The production setup requires an existing application key and does not start runtime processes.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant