getherbie/herbie

Herbie is a simple, modern, fast and highly customizable flat-file Content Management System (CMS) powered by PHP, Twig, Markdown, Textile, reStructuredText and other human-readable text files.

v2.0.0 2023-01-02 09:35 UTC

Requires

• php: >=8.0
• composer-runtime-api: ^2.0
• ext-json: *
• ausi/slug-generator: ^1.1
• imagine/imagine: ^1.3
• psr/container: ^1.1
• psr/event-dispatcher: ^1.0
• psr/http-message: ^1.0
• psr/http-server-middleware: ^1.0
• psr/log: ^1.1
• psr/simple-cache: ^1.0
• symfony/console: ^5.0
• symfony/yaml: ^5.4
• tebe/http-factory: ^2.0
• twig/twig: ^3.4

Requires (Dev)

• codeception/c3: ^2.7
• codeception/codeception: ^4.2
• codeception/module-asserts: ^1.0.0
• codeception/module-phpbrowser: ^1.0.0
• doctrine/rst-parser: ^0.5.2
• erusev/parsedown: ^1.7
• erusev/parsedown-extra: ^0.8.1
• friendsofphp/php-cs-fixer: ^3.11
• getherbie/plugin-simplecontact: dev-master
• getherbie/plugin-simplesearch: dev-master
• laminas/laminas-diactoros: ^2.17
• netcarver/textile: ^3.7
• phpstan/phpstan: ^1.8
• squizlabs/php_codesniffer: ^3.7
• symfony/process: ^5.4

BSD-3-Clause

• blog
• cms
• flat-file
• herbie

README

Herbie

Create small but fully functional websites or blogs in no time and with little effort 👌

Herbie is a simple, modern, fast and highly customizable flat-file Content Management System (CMS) powered by PHP, Twig, Markdown, Textile, reStructuredText and other human-readable text files.

Featuring

Herbie is powered by proven libraries:

• Markdown, reStructuredText and Textile for formatting page content
• Twig template engine for rendering layouts and extending the core
• Yaml and JSON for data structure files
• Composer and Packagist for Dependency and Plugin Management

Thanks to its plugin system Herbie is highly customizable and brings support for:

• Application and Route Middlewares
• Event Listeners
• Twig Filters, Twig Globals, Twig Functions and Twig Tests
• Symfony Console Commands

Herbie implements the following PHP standard recommendations:

• PSR-1 Basic Coding Standard
• PSR-3 Logger Interface
• PSR-4 Autoloading Standard
• PSR-7 HTTP Message Interface
• PSR-11 Container Interface
• PSR-12 Extended Coding Style
• PSR-14 Event Dispatcher
• PSR-15 HTTP Handlers
• PSR-16 Simple Cache
• PSR-17 HTTP Factories

Herbie is well tested:

• Unit, Integration and Acceptance Tests with Codeception
• Static Code Analysis with PHPStan
• Code Fixing with PHP Coding Standards Fixer

Use Cases

TBD

Installation

Composer

The easiest way to install Herbie is through Composer. Run the following commands in your terminal to create a new project and install all dependent libraries.

composer create-project getherbie/start-website mywebsite

Change to the mywebsite/web directory:

cd mywebsite/web

Start the internal webserver:

php -S localhost:8888 index.php

Now open http://localhost:8888 with your browser. You should see your first Herbie website.

Development Environment

If you need a development environment, you can follow these steps.

Clone the GitHub repository.

git clone https://github.com/getherbie/herbie.git

Change to the herbie directory.

cd herbie

Install Composer dependencies.

composer install

Change to the website/web directory.

cd website/web/

Start PHP's internal web server.

php -S localhost:9999 index.php

Now, open localhost:9999 with your favorite web browser.

If you want to have additional console output or logging information, set the debug environment variable.

HERBIE_DEBUG=1 php -S localhost:9999 index.php

If you want to use Xdebug (3.x), start the internal web server as follows. Hint: For this to work, Xdebug must of course be installed.

XDEBUG_MODE=debug php -S localhost:9999 index.php

Tests

Run unit tests

php vendor/bin/codecept run unit

Run integration tests

php vendor/bin/codecept run integration

Run acceptance tests

php vendor/bin/codecept run acceptance

Run all tests

php vendor/bin/codecept run

Run tests with Code Coverage

XDEBUG_MODE=coverage vendor/bin/codecept run --coverage --coverage-xml --coverage-html

More Information

For more information, see https://herbie.tebe.ch.