🪄 Work in progress

This documentation is still a work in progress, so please don’t mind the mess. We also want to assure you that any corpses you see are used for completely legal and sanctioned necromantic purposes. Absolutely no funny business is taking place here.

Installation

But it is said: Do not meddle in the affairs of wizards, for they are subtle and quick to anger. The choice is yours: to go or wait.
— Gildor Inglorion, The Lord of the Rings

Requirements

Arcanist requires PHP 8 and Laravel 8.

Installing Arcanist

Install via composer

composer require laravel-arcanist/arcanist

Preparing your application

While Arcanist aims to be plug-and-play, there are a few things we need to do in order to get our application ready.

Publishing the configuration

After the installation, you should publish its config files by running

This will publish an arcanist.php file into your application's config directory.

Running the migrations

Arcanist adds a new wizards table to keep track of a wizard's state, which is why we need to migrate our database.
php artisan migrate