ash_admin/README.md
2021-03-28 18:36:11 -04:00

1.2 KiB

AshAdmin

Elixir CI License: MIT Coverage Status Hex version badge

An admin UI for Ash resources. Built with Phoenix Liveview.

Usage

First, ensure you've added ash_admin to your mix.exs file.

{:ash_admin, "~> 0.2.1"}

Setup

defmodule MyAppWeb.Router do
  use Phoenix.Router

  import AshAdmin.Router

  # Use your `:browser` pipeline, or use `admin_browser_pipeline` to create one. Only necessary
  # if you don't already have a functioning liveview `:browser` pipeline
  admin_browser_pipeline :browser

  scope "/" do
    # Pipe it through your browser pipeline
    pipe_through [:browser]

    ash_admin "/admin",
      apis: [MyApp.Api1, MyApp.Api2]
  end
end

Configuration

See the documentation in AshAdmin.Resource and AshAdmin.Api for information on the available configuration.