README

This is the official Graphical User Interface (GUI) for Aloia CMS. This package includes the latest version of the Aloia CMS, Authentication, User creation, Media management and the ability to manage the data used by Aloia CMS in a clear and visual web environment.

Requirements

PHP >= 8.0
Laravel 8 or 9

Installation

You can include this package through Composer using:

composer require roelofjan-elsinga/aloia-cms-gui

and if you want to customize any of the default settings used by this package, you can publish the configuration:

php artisan vendor:publish --provider="AloiaCms\\GUI\\ServiceProvider"

This will create a aloiacmsgui.php in your config folder.

Publishing the assets

If you've executed the previous command, to publish the ServiceProvider, you've published the required assets already. If you don't want to publish the ServiceProvider, you can also publish the assets by itself by running:

php artisan aloiacmsgui:publish:assets

This places the assets for the dashboard in public/vendor/aloiacmsgui.

Publishing the secret key

In order to create JWT tokens for authentication, your application needs to use a secret key. First of, add a new entry to your config/app.php file:

return [
    // ... 
    
    'secret' => env('APP_SECRET'),
    
    // ... 
];

Now, you can generate the APP_SECRET key using the following command:

php artisan aloiacmsgui:secret:generate

This will create an entry in your .env file: APP_SECRET=[your-token].

To regenerate this key, you can re-run the command.

Get to your dashboard

Your dashboard is located at /cms/login by default. You can change the prefix in config/aloiacmsgui.php under path.

Editors

By default, two editors are included in this package: CKEditor for HTML pages, and InscrybMDE for Markdown pages.

You can customize which editors you want to use for HTML and Markdown pages by overwriting the views.

Testing

You can run the included tests by running ./vendor/bin/phpunit in your terminal.

roelofjan-elsinga / aloia-cms-gui

Maintainers

Details