README

Demo and test application for Pushword — used for testing, demoing and by the installer. It is not a copy-paste starter; prefer the installer.

Features

• Ready-to-run demo site with fixtures.
• Used by the test suite and the installer.
• Handy to explore every Pushword extension locally.

Build it

cd packages/dev-app;

rm -rf media && cp -r media~ media

php bin/console doctrine:schema:update --force
php bin/console doctrine:fixtures:load

# Add an admin user :
read -p 'Email: ' emailvar
read -sp 'Password: ' passvar
php bin/console pw:user:create $emailvar $passvar ROLE_SUPER_ADMIN
#php bin/console pw:user:create admin@example.tld p@ssword ROLE_SUPER_ADMIN

# Install Bundle Assets
php bin/console assets:install
# `yarn build` Should not be runned because it's erasing the documentation assets.
# the files are there only to help final user on a new installation

# Launch Server and Play
symfony server:start -d

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.
• 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

• PiedWeb
• All Contributors

License

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