geekish/specter

dev-master 2019-11-21 21:56 UTC

This package is auto-updated.

Last update: 2020-10-21 23:58:15 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

Ghost + Laravel = ❤️

Specter provides the means to interact with a Ghost database inside Laravel. Whether you want to use Ghost headless or integrate it into an existing app, this is the package for you.

⚠️ Warning ⚠️

Please note that this is not an API client; Specter accesses your Ghost database directly. Use with caution.

In addition, this package is a work in progress. Breaking changes may be introduced.

Install

composer require geekish/specter

Usage

This package requires Laravel 5.5+ and is set up for auto-discovery.

If you want to use the default routes files provided by Specter, you may add Specter\Providers\RouteServiceProvider to your config/app.php manually.

Customization

If you want to customize config values:

php artisan vendor:publish --provider="Specter\\ServiceProvider"

Currently there is only one config item: posts per page. You may also set this value in your env file:

SPECTER_PER_PAGE=3

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email hannahwarmbier@gmail.com instead of using the issue tracker.

Credits

License

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