README

This package simplifies consuming external statamic installations from your laravel application.

NOT PRODUCTION READ

Motivation

I want my apps to be hosted using Octane which Statamic doesn't support
I don't want my application being "taken over" by Statamic
I love statamic and want to use it for my marketing pages and as a source for content pages within my app

Roadmap

Pass through views, needs specific setup on your statamic installation
- initial implementation done
Auto discover entries of specific collections
Load navigation from api
Load globals from api

Installation

You can install the package via composer:

composer require marvinosswald/statamic-client

You can publish and run the migrations with:

php artisan vendor:publish --tag="statamic-client-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="statamic-client-config"

This is the contents of the published config file:

return [
    'host_url' => env("STATAMIC_HOST_URL"),
    'pass_through' => [
        "enabled" => env('STATAMIC_PASSTHROUGH_ENABLED', true),
        "prefix" => "cms",
        'middleware' => ["web"],
        "view" => "statamic-client::pass-through"
    ],
    'discover' => [
        'enabled' => env('STATAMIC_DISCOVER_ENABLED', true),
    ]
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="statamic-client-views"

Usage

$statamicClient = new Marvinosswald\StatamicClient();
echo $statamicClient->echoPhrase('Hello, Marvinosswald!');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

marvinosswald / statamic-client

Maintainers

Details