README

composer require codymoorhouse/chronicle

关于

此包专为Laravel设计，允许用户通过允许文件上传和评论的笔记互相交互。笔记按部分跟踪并保存，可以附加多个文件/评论。

要使用此包，必须满足以下要求

由于该包仍在开发中，目前并非所有功能都可用。目前建议您通过在所使用的部分上相应地设置布尔值来禁用数据库中的功能。

成功引入包后，(v5.3仅限)您必须在config/app.php文件中注册服务提供程序。

CodyMoorhouse\Chronicle\ChronicleServiceProvider::class,

注册包后，现在可以发布相关文件。这将发布配置文件以及一些默认的Vue组件。

php artisan vendor:publish --provider="CodyMoorhouse\Chronicle\ChronicleServiceProvider"

在运行迁移之前，您可以查看config/chronicle.php文件并根据需要更新值和模型，或者仅使用默认值。然后您可以运行迁移命令来设置所有必需的表。

php artisan migrate

要使用chronicle，您必须在数据库中创建一个部分。为了快速设置部分，您可以使用此命令

php artisan chronicle:section

您指定的标签将在前端使用。您还需要一个用于前端的参考slug。将参考slug视为部分的“子部分”。因此，当您创建部分时，您可以在部分内拥有多个笔记。然而，笔记会被分配一个参考slug，该slug决定了哪些笔记将被显示。

而不是为每个不同的用户创建一个新的部分，您只需设置ref-slug为该用户的id或该用户的唯一slug。现在当用户查看该部分时，他们只会看到具有相同ref slug的笔记。（即 - 他们的id/slug）。

将chronicle注册为Vue实例的组件。

Vue.component('chronicle', require('./components/chronicle/Chronicle'));

在任何app实例中使用此组件。如果不传入用户，chronicle将以“只读”方式显示。

<chronicle tag='my-section' ref-slug="customer-reference-slug" :user="{{ json_encode(Auth::user()) }}"></chronicle>

本项目受MIT许可证保护。请随意在任何您喜欢的地方使用它。