doublethreedigital/runway

This package is abandoned and no longer maintained. The author suggests using the statamic-rad-pack/runway package instead.

Eloquently manage your database models in Statamic.

v5.6.1 2024-01-09 11:10 UTC

Requires

• php: ^8.1
• pixelfear/composer-dist-plugin: ^0.1.5
• statamic/cms: ^4.0

Requires (Dev)

• nunomaduro/collision: ^6.1
• orchestra/testbench: ^7.0
• rector/rector: ^0.14.7
• spatie/test-time: ^1.2

proprietary

README

Runway gives you the ability to display & manage your Eloquent models in Statamic.

"With Runway I was able to quickly make a beautiful admin panel that administrators can use. If Runway didn't exist, it would have taken me a week or two to build something that wasn't quite as nice. Thanks for saving me days and days of work Duncan!"

Erin Dalzell, Certified Statamic Partner

Read the docs.

Features

Control Panel integration

Runway fits right into the Control Panel - enabling you to create, edit and view your models. In most cases, you'll not notice the difference between an entry in the CP and an Eloquent model in the CP.

• Review documentation

Front-end routing

Need to show your models on the front-end of your site? No problem - Runway's got that under control. Simply tell Runway the route you'd like to use and it'll serve up the front-end for you.

// config/runway.php

return [
    'resources' => [
        \App\Models\Product::class => [
            'route' => '/products/{{ slug }}',
        ],
    ],
];

• Review documentation

Antlers templating

In addition to front-end routing, you may also use Runway's tag to loop through your models and display the results. The tag supports filtering, using Eloquent scopes and sorting.

{{ runway:products }}
    <h2>{{ name }}</h2>
    <p>Price: {{ price }}</p>
{{ /runway:products }}

• Review documentation

GraphQL API

If you're a GraphQL fan, you're now able to fetch your models via GraphQL. Runway will augment the fields just like you'd expect.

{
    products(limit: 25, sort: "name") {
        data {
            id
            name
            price
            description
        }
    }
}

REST API

If you don't like GraphQL and would prefer plain old REST, you can do that too. Runway easily integrates with Statamic's REST API.

'resources' => [
    'collections' => true,
    // ...
    'runway' => [
        'product' => true,
    ],
],

Support

If you find a bug, have some question or have a feature request, please open a GitHub Issue or Discussion.

Please note: only the latest version of this addon is supported. Any bug reports regarding an old version will be closed.

Contributing

Contributions are welcome, and are accepted via pull requests. You should follow this process when contributing:

1. Fork the repository
2. Make your code change
3. Open a pull request, detailing the changes you've made.

If your pull request is a Work in Progress, please mark your pull request as a draft.

Security

If you've found a bug regarding security please email [e-mail] instead of using the issue tracker.