Runway 项目使用教程

Runway 项目使用教程

1. 项目介绍

Runway 是一个用于在 Statamic 中优雅管理数据库模型的开源项目。它通过与 Statamic 控制面板的集成，使得用户可以轻松地创建、编辑和查看 Eloquent 模型。Runway 不仅简化了前端路由的管理，还支持 Antlers 模板和 GraphQL/REST API，极大地提升了开发效率。

2. 项目快速启动

安装 Runway

首先，确保你已经安装了 Statamic 和 Composer。然后，通过 Composer 安装 Runway：

composer require statamic-rad-pack/runway

配置 Runway

在 config/runway.php 中配置你的模型和路由：

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

使用 Runway 标签

在前端模板中使用 Runway 标签来循环显示模型数据：

[[ runway:product ]]
    <h2>[[ name ]]</h2>
    <p>Price: [[ price ]]</p>
[[ /runway:product ]]

3. 应用案例和最佳实践

案例一：电商网站

在一个电商网站中，使用 Runway 管理产品模型，并通过前端路由展示产品列表和详情页。通过 GraphQL API 获取产品数据，实现前后端分离。

案例二：博客系统

在博客系统中，使用 Runway 管理文章模型，并通过 Antlers 模板展示文章列表和单篇文章。通过 REST API 提供文章数据给移动应用。

4. 典型生态项目

Statamic

Statamic 是一个无数据库的 CMS，Runway 为其提供了数据库模型的管理能力，扩展了 Statamic 的功能。

Laravel

Runway 基于 Laravel 的 Eloquent ORM，充分利用了 Laravel 的强大功能和生态系统。

GraphQL

Runway 支持 GraphQL API，可以与 GraphQL 生态项目如 Apollo 等无缝集成，提供高效的数据查询和操作。

REST API

Runway 也支持 REST API，可以与各种前端框架如 React、Vue.js 等配合使用，实现前后端分离的开发模式。

通过以上模块的介绍和实践，你可以快速上手并深入使用 Runway 项目，提升开发效率和项目质量。