2020-11-26 10:17:04 +13:00
|
|
|
# AshAdmin
|
|
|
|
|
2021-03-22 17:05:49 +13:00
|
|
|
![Elixir CI](https://github.com/ash-project/ash_admin/workflows/Elixir%20CI/badge.svg)
|
|
|
|
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
|
|
|
|
[![Coverage Status](https://coveralls.io/repos/github/ash-project/ash_admin/badge.svg?branch=master)](https://coveralls.io/github/ash-project/ash_admin?branch=master)
|
|
|
|
[![Hex version badge](https://img.shields.io/hexpm/v/ash_admin.svg)](https://hex.pm/packages/ash_admin)
|
2020-11-26 10:17:04 +13:00
|
|
|
|
2021-03-22 17:05:49 +13:00
|
|
|
An admin UI for Ash resources. Built with Phoenix Liveview.
|
2020-11-26 10:17:04 +13:00
|
|
|
|
2021-03-22 17:05:49 +13:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
First, ensure you've added ash_admin to your `mix.exs` file.
|
|
|
|
|
|
|
|
```elixir
|
2021-03-23 14:39:04 +13:00
|
|
|
{:ash_admin, "~> 0.1.3"}
|
2021-03-22 17:05:49 +13:00
|
|
|
```
|
|
|
|
|
|
|
|
## Setup
|
2020-11-26 10:17:04 +13:00
|
|
|
|
|
|
|
```elixir
|
2021-03-22 17:05:49 +13:00
|
|
|
defmodule MyAppWeb.Router do
|
|
|
|
use Phoenix.Router
|
|
|
|
|
2021-03-23 14:41:00 +13:00
|
|
|
import AshAdmin.Router
|
|
|
|
|
2021-03-22 17:05:49 +13:00
|
|
|
# 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
|
2021-03-23 14:41:00 +13:00
|
|
|
admin_browser_pipeline :browser
|
2021-03-22 17:05:49 +13:00
|
|
|
|
|
|
|
scope "/" do
|
|
|
|
# Pipe it through your browser pipeline
|
2021-03-23 14:41:00 +13:00
|
|
|
pipe_through [:browser]
|
2021-03-22 17:05:49 +13:00
|
|
|
|
|
|
|
ash_admin "/admin",
|
|
|
|
apis: [MyApp.Api1, MyApp.Api2]
|
|
|
|
end
|
2020-11-26 10:17:04 +13:00
|
|
|
end
|
|
|
|
```
|
|
|
|
|
2021-03-22 17:05:49 +13:00
|
|
|
## Configuration
|
2020-11-26 10:17:04 +13:00
|
|
|
|
2021-03-22 17:05:49 +13:00
|
|
|
See the documentation in `AshAdmin.Resource` and `AshAdmin.Api` for information on the available configuration.
|