README

Prerequisites

PHP 7.2+
Composer (PHP dependency manager)

I recommend using the latest available version of PHP as a matter of principle.

Installation

Start a new Artefakt Pattern Library by running this on a command prompt (requires Composer to be available as composer):

composer create-project --prefer-dist apparat/artefakt <project-name>
cd <project-name>

Please make sure to replace <project-name> with the path and name of your project.

Custom directories

If you want Artefakt to use other directories than the default ones, create a custom composer.json in your installation directory:

mkdir <project-name>
cd <project-name>
composer init

Edit your composer.json to specify one or more custom directories like this:

{
    "name": "your/project",
    "require": {
        "apparat/artefakt": "dev-master"
    },
    "extra": {
        "apparat/artefakt": {
            "components": "cpms", // Component data directory
            "documents": "docs", // Document data directory
            "cache": "/tmp/artefakt" // Cache directory
        }
    }
}

Relative paths are resolved against the installation directory (the directory where the composer.json resides). Finish the installation with:

composer install
vendor/bin/artefakt app:init

Dependencies

Quality

The Artefakt set of libraries attempt to comply with PSR-1, PSR-2, and PSR-4. If you notice compliance oversights, please send a patch for the respective library via pull request.

Contributing

Found a bug or have a feature request? Please have a look at the known issues first and open a new issue if necessary. Please see contributing and conduct for details.

Security

If you discover any security related issues, please email joschi@kuphal.net instead of using the issue tracker.

apparat / artefakt

Maintainers

Details