Skip to content
A rapid admin generator for Elixir & Phoenix
Branch: master
Clone or download
Latest commit 59c3e9d Feb 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
bin Install coveralls Apr 30, 2018
config
lib Add I18N support. This close issues #101. Jan 1, 2019
priv Add I18N support. This close issues #101. Jan 1, 2019
test
.credo.exs
.formatter.exs
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md Update README to reflect transfer Jan 26, 2019
coveralls.json Install coveralls Apr 30, 2018
mix.exs Make tests pass Feb 2, 2019
mix.lock Make tests pass Feb 2, 2019

README.md

Hex.pm Build Status Deps Status

phoenix_torch_logo

Torch

Torch is a rapid admin generator for Phoenix apps. It creates custom templates and relies on the Phoenix html generator under the hood.

image

Installation

To install Torch, perform the following steps:

  1. Add torch to your list of dependencies in mix.exs. Then, run mix deps.get:
def deps do
  [
    {:torch, "~> 2.0.0-rc.1"}
  ]
end
  1. Add a Plug.Static plug to your endpoint.ex:
plug(
  Plug.Static,
  at: "/torch",
  from: {:torch, "priv/static"},
  gzip: true,
  cache_control_for_etags: "public, max-age=86400"
)
  1. Configure Torch by adding the following to your config.exs.
config :torch,
  otp_app: :my_app_name,
  template_format: "eex" || "slim"
  1. Run mix torch.install

NOTE: If you choose to use slim templates, you will need to install Phoenix Slim.

Now you're ready to start generating your admin! 🎉

Usage

Torch uses Phoenix generators under the hood. Torch injects it's own custom templates into your priv/static directory, then runs the mix phx.gen.html task with the options you passed in. Finally, it uninstalls the custom templates so they don't interfere with running the plain Phoenix generators.

In light of that fact, the torch.gen.html task takes all the same arguments as the phx.gen.html, but does some extra configuration on either end. Checkout mix help phx.gen.html for more details about the supported options and format.

For example, if we wanted to generate a blog with a Post model we could run the following command:

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

The output would look like:

Add the resource to your browser scope in lib/my_app_web/router.ex:

    resources "/posts", PostController

Ensure the following is added to your endpoint.ex:

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

  :fire: Torch generated html for Posts! :fire:

Torch also installed an admin layout into your my_app_web/templates/layout/torch.html.eex. You will want to update it to include your new navigation link:

<nav class="torch-nav">
  <a href="/posts">Posts</a>
</nav>

Association filters

Torch does not support association filters at this time. Filtrex does not yet support them.

You can checkout these two issues to see the latest updates:

https://github.com/rcdilorenzo/filtrex/issues/55

https://github.com/rcdilorenzo/filtrex/issues/38

However, that does not mean you can't roll your own.

Example

We have a Accounts.User model that has_many :credentials, Accounts.Credential and we want to support filtering users by credentials.email.

  1. Update the Accounts domain.
# accounts.ex
...
defp do_paginate_users(filter, params) do
  credential_params = Map.get(params, "credentials")
  params = Map.drop(params, ["credentials"])

  User
  |> Filtrex.query(filter)
  |> credential_filters(credential_params)
  |> order_by(^sort(params))
  |> paginate(Repo, params, @pagination)
end

defp credential_filters(query, nil), do: query

defp credential_filters(query, params) do
  search_string = "%#{params["email"]}%"

  from(u in query,
    join: c in assoc(u, :credentials),
    where: like(c.email, ^search_string),
    group_by: u.id
  )
end
...
  1. Update form filters.
# users/index.html.eex
<div class="field">
  <label>Credential email</label>
  <%= text_input(:credentials, :email, value: maybe(@conn.params, ["credentials", "email"])) %>
</div>

Note: You'll need to install & import Maybe into your views {:maybe, "~> 1.0.0"} for the above eex to work.

Styling

Torch generates two CSS themes you can use: base.css & theme.css. The base styles are basically bare bones, and the theme styles look like the screenshot above. Just change the stylesheet link in the torch.html.eex layout.

If you want to use the theme, but override the colors, you'll need to include your own stylesheet with the specific overrides.

You can’t perform that action at this time.