README

Starter template for a project built on the z77 framework.

Prerequisites

PHP ≥ 8.2 (CLI) with the mbstring, fileinfo and gd extensions enabled — the installer and the site run on it (apcu is optional but recommended: faster cache)
Composer 2.x

That's all. Node.js is only needed if you edit the framework's SCSS — see dev-environment for the full toolchain.

Start a project

Without git — the simplest way:

composer create-project z77/skeleton my-project
cd my-project
composer dev        # serves http://localhost:8080 from public/

With git — use this repo as a GitHub template:

Click Use this template → create your repository, then clone it.
composer install
composer dev

Either way, the installer creates public/, config/, data/, override/, lib/, logs/ and seeds a runnable starter site. You don't create these by hand.

You write your project under override/z77/…; the framework packages stay untouched in vendor/ and are updated with composer update.

What's in this template

Only composer.json. Everything else is generated by the installer on the first composer install. Version-control your project however you like — this template deliberately ships no .gitignore: what you commit is your call.

AI-assisted development

During install you are asked whether to add z77/docs — the complete, AI-optimized framework documentation — as a dev dependency. Say yes (default) and it lands in vendor/z77/docs, version-matched to the framework and excluded from --no-dev deploys. The installer also seeds a project CLAUDE.md pointing your AI assistant (e.g. Claude Code) at the docs and the override rules: open the project, ask "what do we have here?", and it can start working. Skipped it? composer require --dev z77/docs adds it any time.

Documentation

The full handbook lives in the framework repo: z77-ch/z77-framework/docs. Good first reads: architecture · create-page · create-module

License

MIT

z77 / skeleton

Maintainers

Package info

Statistics

Security