mj-zana / skeleton-web

v2.19.2 2026-11-07 09:53 UTC

Requires

• php: ^8.5
• mj-zana/cache: ^2.19
• mj-zana/console: ^2.19
• mj-zana/core: ^2.19
• mj-zana/http: ^2.19
• mj-zana/logging: ^2.19
• mj-zana/routing: ^2.19
• mj-zana/security: ^2.19
• mj-zana/translation: ^2.19
• mj-zana/view: ^2.19

Requires (Dev)

• mj-zana/maker: ^2.19
• mj-zana/testing: ^2.19
• phpunit/phpunit: ^11.5

Suggests

• ext-zip: Needed by release:build to write the upload archives

MIT

• Skeleton
• website
• zana

Published on Packagist.org on 2026-11-07 09:54 UTC

README

A starting point for a website on Zana: pages in English and French, templates, page metadata, versioned assets, security headers, translated error pages, and upload archives for shared hosting.

composer create-project mj-zana/skeleton-web my-site
cd my-site
composer serve

Open http://localhost:8000. composer create-project writes .env with a fresh secret.

What is where

Path
src/Bootstrap.php	The framework's providers
config/	Settings; APP_A__B in the environment or .env overrides a.b
modules/Site/	The pages: routes in SiteModule, PageController, templates and translations
templates/	The layout and the error pages
translations/	Texts shared by every module
public/	The document root: index.php, assets, 503.html
tests/	Browser tests: composer test, which also runs the tests in modules/*/Tests
AGENTS.md	The rules and workflow for AI coding agents (CLAUDE.md and .github/ point to it)

Add pages with the maker, installed for development:

php bin/console make:page Site Services

For a JSON endpoint, add the packages it needs and register their providers in src/Bootstrap.php (the command lists them), then generate the whole use case:

composer require mj-zana/mediator mj-zana/ddd mj-zana/serialization mj-zana/validation
php bin/console make:feature Site RequestQuote --field=email:string --http

The tests run without .env: in the testing environment, config/testing/security.php gives them a secret of their own.

See what the application contains and check it after a change (--format=json for agents):

php bin/console inspect
php bin/console check

After upgrading Zana, write AGENTS.md again with php bin/console make:agents --force, then add back any section of your own; tests/AgentsFileTest.php reminds you.

Going live

1. On the server, set APP_ENV=production, APP_APP__URL and APP_SECURITY__SECRET, in the environment or in .env.
2. Make var/ writable.
3. Check the server: php bin/console doctor, and the mail settings: php bin/console mail:test [e-mail] once mj-zana/communication is installed.

When a page shows the error page, the reason is in var/log/app.log (config/logging.php).

The document root is public/. When the hosting fixes the document root to the project folder, the root .htaccess sends every request into public/, so .env, config/ and vendor/ cannot be reached.

Shared hosting without SSH (cPanel and the like, where public_html is fixed and Composer cannot run):

php bin/console release:build

It writes two archives from the last commit, with the production dependencies installed:

• build/website.zip: unpack it beside public_html, so the project is in ~/website;
• build/public_html.zip: unpack it into public_html. Its index.php finds the project in ../website (--folder picks another name).

It finds Composer on the PATH, on Windows too; --composer points at another one, -v shows its output, and --timeout (600 seconds) stops a build that hangs. The command comes from mj-zana/console, so composer update brings its fixes.

Create ~/website/.env on the server, and delete ~/website/var/cache after each upload so the container and the configuration are read again.

The deployment guide covers all of it.

License

MIT