GitXplorerGitXplorer
f

phoenix_live_debug_console

public
6 stars
0 forks
1 issues

Commits

List of commits on branch main.
Unverified
ec8b392292c7cc82ce5606d5e3e17feae9a4730c

Bump version number for 'mix docs' fix

ffrerich committed 2 years ago
Unverified
332cb5175697ed0071a004fdb3b2b4b738d2dbe2

Give less restrictive installation instructions

ffrerich committed 2 years ago
Unverified
d37f215bd6348fc8766622d290f682c477f3d9f6

Made 'mix docs' work

ffrerich committed 2 years ago
Unverified
c4faf15fd4079ae8a2346694f9f8c102679d6f00

Add infrastructure for building proper Hex packages

ffrerich committed 2 years ago
Unverified
4f3e3b5bb90e8215a51ce57a5d32d315e0acf37d

Add LICENSE file

ffrerich committed 2 years ago
Unverified
e0760f437f1346a24ffba2a3ba5f829af42d2060

Mention that a custom build of Phoenix is required for this

ffrerich committed 2 years ago

README

The README file for this repository.

Phoenix LiveDebugConsole

This package implements an extension to the error view shown in Phoenix applications, adding a fully-interactive IEx shell. Here's a video of me triggering an error in a Phoenix application and then poking around a little bit using the live debug console:

https://user-images.githubusercontent.com/533425/189327007-a3fc4bda-8519-4a02-9a7c-f8b1331e19a9.mov

Installation

  1. This package currently requires that your application uses a bleeding edge development build of Phoenix which has https://github.com/phoenixframework/phoenix/pull/4938 applied.

  2. Install the package by adding phoenix_live_debug_console to your list of dependencies in mix.exs:

def deps do
  [
    {:phoenix_live_debug_console, "~> 0.1"}
  ]
end
  1. Configure the endpoint of your application such that debug_errors and debug_error_handlers are set as follows:
config :my_app, MyAppWeb.Endpoint,
  debug_errors: true,
  debug_banner_hooks: [{PhoenixLiveDebugConsole, :render_console, []}]

Credits

This library was written by Frerich Raabe, however it is really just standing on the shoulders of giants:

  • Underthehood is what implements the IEx terminal
  • Phoenix LiveDashboard served as an inspiration for developing an extension package which comes with its own assets.