Torch 开源项目教程

Torch 开源项目教程

torch A rapid admin generator for Elixir & Phoenix 项目地址: https://gitcode.com/gh_mirrors/tor/torch

1. 项目介绍

Torch 是一个为 Phoenix 应用程序设计的快速管理员生成器。它能够创建自定义模板，并依赖于 Phoenix HTML 生成器内部机制。Torch 支持 Phoenix 1.7 及以上版本，并且需要 Elixir 1.14+ 和 OTP 24+。

2. 项目快速启动

要安装 Torch，请按照以下步骤操作：

首先，将 Torch 添加到 mix.exs 文件的依赖列表中，然后运行 mix deps.get：

def deps do
  [
    {:torch, "~> 5.5"}
  ]
end

接下来，在 endpoint.ex 文件中添加一个 Plug.Static 插件：

plug(
  Plug.Static,
  at: "/torch",
  from: {:torch, "priv/static"},
  gzip: true,
  cache_control_for_etags: "public, max-age=86400",
  headers: [{"access-control-allow-origin", "*"}]
)

在 config.exs 文件中配置 Torch：

config :torch, otp_app: :my_app_name

运行以下命令安装 Torch：

mix torch.install

现在，您可以开始生成管理员界面了。

3. 应用案例和最佳实践

假设我们要为一个博客创建一个 Post 模型，可以运行以下命令：

mix torch.gen.html Blog Post posts title:string body:text published_at:datetime published:boolean views:integer

该命令会在 priv/templates/phx.gen.html 目录下创建相应的模板文件。之后，将这些资源添加到路由中：

resources "/posts", PostController

记得运行迁移来更新数据库：

mix ecto.migrate

确保 endpoint.ex 文件中配置了静态文件处理，并添加了管理员布局链接到 torch.html.heex 文件中。

如果您需要在现有系统中添加 Torch，而您的应用程序已经包含了模块和控制器，您只想使用 Torch 管理界面，可以使用以下命令：

mix torch.gen.html Blog Post posts --no-schema --no-context --web Admin title:string body:text published_at:datetime published:boolean views:integer

4. 典型生态项目

Torch 可以与多种 Phoenix 生态项目配合使用，例如：

• Filtrex：提供复杂的过滤功能。
• Scrivener：用于分页。
• Phoenix LiveView：为 Phoenix 应用程序提供实时界面。

这些项目可以与 Torch 一起工作，以提供更丰富的功能。在整合这些项目时，请确保遵循它们的文档和最佳实践。

torch A rapid admin generator for Elixir & Phoenix 项目地址: https://gitcode.com/gh_mirrors/tor/torch