diff --git a/README.md b/README.md index 78fbf61..fabe394 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,6 @@ -``` - _ __ _____ ____ _ ___ ___ _ __ (_)_ _ _ __ ___ -| '_ \ / _ \ \ / / _` |/ __/ _ \| '_ \| | | | | '_ ` _ \ -| | | | (_) \ V / (_| | (_| (_) | | | | | |_| | | | | | | -|_| |_|\___/ \_/ \__,_|\___\___/|_| |_|_|\__,_|_| |_| |_| -``` +![Novaconium PHP](https://i.4lt.ca/git/novaconium-logo.png) -# novaconium - -A tiny, Hugo-flavored PHP micro-framework. Routes are directories on disk, pages render with [Twig](https://twig.symfony.com/), and any page that needs real logic gets an optional PHP "sidecar" file. Pages without a sidecar are pre-rendered once and served as static HTML straight from Apache afterwards. No Composer — Twig is vendored directly into the repo as plain source files. +A Hugo-flavored PHP framework. Routes are directories on disk, pages render with [Twig](https://twig.symfony.com/), and any page that needs real logic gets an optional PHP "sidecar" file. Pages without a sidecar are pre-rendered once and served as static HTML straight from Apache afterwards. For a full tour of what's included — routing, sidecars, caching, admin auth, access control, media manager, database, search, RSS, and more — see the [Novaconium Features](http://127.0.0.1:8000/blog/novaconium-features) post once the site is running, or `/admin/docs` (see Documentation below). @@ -17,7 +10,7 @@ For a full tour of what's included — routing, sidecars, caching, admin auth, a PHP 8.1+ (uses `readonly` constructor-promoted properties) and, for production, Apache with `mod_rewrite` and `AllowOverride All`. A few optional features (database, content index/search, admin authentication) need the `pdo_sqlite` extension — see `/admin/docs` for details once running. -### Developers +### Development Run it locally, no Apache needed: @@ -27,6 +20,13 @@ php -S 127.0.0.1:8000 -t public public/router.php Visit `http://127.0.0.1:8000/` — click around the example pages, then open `http://127.0.0.1:8000/admin/docs` for the complete documentation, rendered live from this same instance. +### Production + +``` +docker compose up -d +root@b2c4133264c6:/var/www/html# php novaconium/bin/create-admin-user.php nick c@nickyeoman.com +``` + ### Webmasters - Clone this repo.