Getting started

Installation

New project

1. Create project

composer create-project codex/codex

2. Configure

You should now configure Codex to suit your needs. Head over to the configuration page.

3. Serve

php artisan serve

Existing project

1. Add to composer

composer require codex/core

2. Add service provider

# config/app.php
return [
    // ...
    'providers' => [
        // ...
        Codex\CodexServiceProvider::class
    ]
];

3. Publish and configure the configuration file

php artisan vendor:publish --provider=Codex\Core\CodexServiceProvider --tag=config

4. Publish the asset files

php artisan vendor:publish --provider=Codex\Core\CodexServiceProvider --tag=public

5. Publish the view files (optional)

php artisan vendor:publish --provider=Codex\Core\CodexServiceProvider --tag=views

6. Add composer post-install-cmd to auto hook to re-publish

{ 
    "scripts": {
        "post-install-cmd": [
            "Illuminate\\Foundation\\ComposerScripts::postInstall",
            "php artisan optimize",
            "php artisan vendor:publish --tag=public --force"
        ],
        "post-update-cmd": [
            "Illuminate\\Foundation\\ComposerScripts::postUpdate",
            "php artisan vendor:publish --tag=public --force"
        ]
    }
}

7. Configure Codex

You should now configure Codex to suit your needs. Head over to the configuration page.