ash-project/ash_admin
1
0
Fork 0
mirror of https://github.com/ash-project/ash_admin.git synced 2024-09-19 21:03:52 +12:00
Code Issues Projects Releases Packages Wiki Activity

docs: Merge pull request #1 from axelson/readme-update

Browse source
This commit is contained in:
Zach Daniel 2021-03-29 11:46:47 -04:00 committed by GitHub
commit 505ea5f305
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -2,10 +2,14 @@
![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)
[![Coverage Status](https://coveralls.io/repos/github/ash-project/ash_admin/badge.svg?branch=main)](https://coveralls.io/github/ash-project/ash_admin?branch=main)
[![Hex version badge](https://img.shields.io/hexpm/v/ash_admin.svg)](https://hex.pm/packages/ash_admin)
An admin UI for Ash resources. Built with Phoenix Liveview.
An admin UI for Ash resources. Built with Phoenix LiveView.
## Demo
https://www.youtube.com/watch?v=aFMLz3cpQ8c
## Usage
@ -17,14 +21,16 @@ First, ensure you've added ash_admin to your `mix.exs` file.
## Setup
Modify your router to add ash admin:
```elixir
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
# AshAdmin requires a Phoenix LiveView `:browser` pipeline
# If you DO NOT have a `:browser` pipeline already, then AshAdmin has a `:browser` pipeline
# Most applications will not need this:
admin_browser_pipeline :browser
scope "/" do
@ -37,6 +43,8 @@ defmodule MyAppWeb.Router do
end
```
Now start your project (usually by running `mix phx.server` in a terminal) and visit `/admin` in your browser (or whatever path you gave to `ash_admin` in your router).
## Configuration
See the documentation in `AshAdmin.Resource` and `AshAdmin.Api` for information on the available configuration.
See the documentation in [`AshAdmin.Resource`](https://hexdocs.pm/ash_admin/AshAdmin.Resource.html) and [`AshAdmin.Api`](https://hexdocs.pm/ash_admin/AshAdmin.Api.html) for information on the available configuration.