README

Typhoon 是一种按您希望的方式管理内容的方式。为什么是 Typhoon？因为它不使用数据库。它使用 Orbit。

支持我们

您可以通过此处支持这个开源包的开发

安装

从 Laravel 的全新安装开始

laravel new your-awesome-project-name

或

composer create-project laravel/laravel your-awesome-project-name

进入您的项目目录

cd your-awesome-project-name

您可以通过 composer 安装此包

composer require happytodev/typhoon

作为 Typhoon，使用 Ryan Chandler 的 filament-navigation 插件，以及我根据它（分支在此 https://github.com/happytodev/filament-navigation）进行修改以符合 Orbit（也是由 Ryan 提供）的要求。由于 PR 正等待 Ryan 的批准，您必须在安装 Typhoon 之前设置其他设置。

按照以下步骤操作

    "repositories": [
        {
          "type": "vcs",
          "url": "https://github.com/happytodev/filament-navigation"
        }
    ],
    "require": {
      "ryangjchandler/filament-navigation": "dev-main"
    }

保存 composer.json 文件并运行 composer update

或者，如果您没有在 composer.json 文件中添加上述 require 块，您可以通过 composer 安装包

composer require ryangjchandler/filament-navigation=dev-main

要使用 filament-navigation 与 Orbit 一起，您必须在 .env 文件中添加一个密钥

  FILAMENT_NAVIGATION_DB_ENGINE=orbit

通过在 .env 文件中添加以下密钥来为您的网站命名

TYPHOONCMS_NAME="MyWebsite"

始终在您的 .env 文件中用以下内容替换

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=

替换为

DB_CONNECTION=orbit

现在，您可以通过 Artisan 运行 Typhoon 的安装脚本

php artisan typhoon:install

当脚本询问 用户模型文件已存在。您想覆盖它吗？(是/否) [no]: 时，您可以回答 yes。它将修改默认用户模型以适应使用 Orbit 而不是像 MySQL 这样的经典数据库。

最后一件事，转到 content\users 文件夹，并使用您喜欢的编辑器编辑第一个用户，通常是文件 1.md

---
id: 1
name: 'John Doe'
email: john@doe.com
password: $2y$10$0wdxKSl7ksxk8yrTgU8!K90oLmMq2eJ20pwUBSu0ICMWpc959DpTqm
is_admin: 0
created_at: 2022-05-27T18:39:22+00:00
updated_at: 2022-05-28T09:04:57+00:00
---

将此行 is_admin: 0 修改为这一行 is_admin: true

---
id: 1
name: 'John Doe'
email: john@doe.com
password: $2y$10$0wdxKSl7ksxk8yrTgU8!K90oLmMq2eJ20pwUBSu0ICMWpc959DpTqm
is_admin: true
created_at: 2022-05-27T18:39:22+00:00
updated_at: 2022-05-28T09:04:57+00:00
---

计划任务

Typhoon 可以通过设置操作日期和时间来发布或取消发布帖子。它需要您按照 laravel 文档 中解释的方式进行 crontab 配置。

以下内容必须根据您的系统进行调整，但在经典 Linux 上

crontab -e

然后添加以下内容，并注意根据您的 Typhoon 安装路径进行调整

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

编译资源

只有当您需要调整资源并编译它们时

安装 TailwindCSS

npm install -D tailwindcss

npm install @tailwindcss/typography

安装 Npm 依赖关系并编译资源

npm install && npm run dev

编译 Tailwind 资产

npx tailwindcss -i ./resources/css/app.css -o ./public/css/app.css

更新

更新 TyhoonCms 后，您可以通过 composer update 运行 php artisan typhoon:update。

脚本将询问您从哪个版本开始，并根据需要进行更新。

如何连接

现在您可以通过将 /admin 添加到您的项目 URL 来连接到后台办公室

如何使用

开箱即用，您有这些实体

• 用户
• 帖子
• 分类
• 标签
• 页面
• 导航
• 社交网络

要创建帖子，需要分类。因此，您的第一步是创建一个分类，然后再创建帖子。

安装后，您将带有以下示例内容

• 主页
• 您的用户和一个默认用户 john@doe.com 和密码： johndoesecret
• 一个分类
• 一个标签
• 一个演示帖子： yourTyphoonSite.test/posts/the-first-post-with-typhoon
• 一个菜单
• 一个社交网络群组
• 列出所有帖子的页面： yourTyphoonSite.test/posts/

当您创建一个页面时，您可以使用此URL访问它

yourTyphoonSite.test/page/{您页面的slug}

主页与此不同，直接链接到 yourTyphoonSite.test/

已知限制

别忘了：这是一个测试版，除非您知道自己在做什么，否则请不要在生产环境中使用！

目前存在一些限制

• 在导航中，只有提供的模板中的一个菜单可用，并且其名称必须是 main
• 在社交网络中，群组的名称也必须是 main

测试

composer test

更新日志

请参阅 更新日志 获取最近更改的更多信息。

贡献

请参阅 贡献指南 了解详细信息。

安全漏洞

请参阅 我们的安全策略 了解如何报告安全漏洞。

致谢

• Frédéric Blanc
• 所有贡献者

许可证

MIT许可证（MIT）。请参阅 许可证文件 获取更多信息。

版本控制

TyphoonCms开发遵循 SemVer 方法。