README

Install Pushword and its packages in minutes — an interactive setup script plus automatic per-package install hooks.

Features

Interactive setup during composer create-project (database, admin user, routes, assets).
Automatic package setup — runs each package's install.php on composer require.
Stays installed to support future package installs.

How It Works

This package provides two mechanisms:

Interactive Setup (src/installer): A bash script that runs once during composer create-project to set up a new Pushword project (database, admin user, routes, assets).
Automatic Package Setup (PostInstall::runPostUpdate): Automatically executes each package's install.php when you add new Pushword packages via composer require.

After initial setup, pushword/installer remains installed to support future package installations. Only the interactive bash script reference is removed from post-install-cmd.

Manual Installation

If you prefer not to use automatic installation, you can:

Remove pushword/installer from your dependencies
Manually follow the steps in each package's install.php file

Documentation

Visit pushword.piedweb.com/installation.

The Pushword ecosystem

Pushword is a modular CMS — one Symfony bundle for the core and one bundle per feature. Pick only what you need:

Core

pushword/core — Symfony-based CMS core: Page, Media & User entities, Markdown + Twig rendering.

Editing & admin

pushword/admin — EasyAdmin interface to manage pages, media and users.
pushword/admin-block-editor — Gutenberg-like block editor (stores Markdown).
pushword/advanced-main-image — Hero images & main-image format control.
pushword/template-editor — Edit Twig templates online.
pushword/snippet — Reusable content fragments & components.

Content & workflow

pushword/flat — Flat-file (Markdown + Git) CMS mode.
pushword/version — Page & snippet versioning.
pushword/page-update-notifier — Email alerts on content changes.
pushword/conversation — Comments, contact & newsletter forms.

Publishing & performance

pushword/static-generator — Export a static website (GitHub Pages, Apache, FrankenPHP).
pushword/search — SQLite full-text search (Loupe), zero infra.
pushword/page-scanner — Find dead links, 404s, redirects & TODOs.
pushword/api — Token-authenticated REST API.

Tooling

pushword/installer — Project & package installer. (this package)
pushword/js-helper — Front-end JavaScript helpers.

Full list and guides on pushword.piedweb.com/extensions.

Contributing

If you're interested in contributing to Pushword, please read our contributing docs before submitting a pull request.

Credits

License

The MIT License (MIT). Please see License File for more information.

pushword / installer

Maintainers

Package info

Statistics

Security