An open API service indexing awesome lists of open source software.

https://github.com/defactosoftware/notfoundroute

An overview of all routes in your Phoenix project.
https://github.com/defactosoftware/notfoundroute

elixir phoenix routes

Last synced: 10 months ago
JSON representation

An overview of all routes in your Phoenix project.

Awesome Lists containing this project

README

          

[![Hex pm](http://img.shields.io/hexpm/v/not_found_route.svg?style=flat)](https://hex.pm/packages/not_found_route)

# NotFoundRoute

Shows the routes in a (non umbrella) phoenix app with a live filter through all
routes. This is only enabled in `:dev` mode

![search](https://user-images.githubusercontent.com/1089927/102547581-b08ba000-40b9-11eb-83bd-5f72249e0999.gif)

Needed to run:
* Phoenix > 1.4
* LiveView (only needed for search)

## Install

Add to `mix.exs`

```ex
def deps do
# ...
{:not_found_route, "0.0.2"}
end
```

In `lib/my_app_web/router.ex`

```ex
defmodule MyAppWeb.Router do
# ...
import NotFoundRouteWeb.Router
# ...

# Add this as last route in the "/" scope
live_not_found()
end
```

## Usage

Go to a route that is not defined in the router, for example `/not-found`
where a page comes up with all the routes available in your appp.

Search works for each column, when clicking on a column search will work only
for that column.