GitHub - software-mansion/live-debugger: Tool for debugging LiveView applications.

LiveDebugger is a browser-based tool for debugging applications written in Phoenix LiveView - an Elixir library designed for building rich, interactive online experiences with server-rendered HTML.

Designed to enhance your development experience LiveDebugger gives you:

🌳 See your LiveComponents tree
🔍 View assigns
🔗 Trace and filter callback executions
🔦 Inspect elements

Check out our comprehensive Features Overview to explore all capabilities in detail.

meet-livedebugger.mp4

Getting started

Important

LiveDebugger should not be used on production - make sure that the dependency you've added is :dev only

Mix installation

Add live_debugger to your list of dependencies in mix.exs:

  defp deps do
    [
      {:live_debugger, "~> 0.6.0", only: :dev}
    ]
  end

For full experience we recommend adding below line to your application root layout. It attaches meta tag and LiveDebugger scripts in dev environment enabling browser features.

  # lib/my_app_web/components/layouts/root.html.heex

  <head>
    <%= Application.get_env(:live_debugger, :live_debugger_tags) %>
  </head>

After you start your application, LiveDebugger will be running at a default port http://localhost:4007.

Igniter installation

LiveDebugger has Igniter support - an alternative for standard mix installation. It'll automatically add LiveDebugger dependency and modify your root.html.heex after you use the below command.

mix igniter.install live_debugger

DevTools extension

Since version v0.2.0 you can install official LiveDebugger DevTools extension, giving you the ability to interact with its features alongside your application's runtime.

Note

Ensure the main LiveDebugger dependency is added to your mix project, as the browser plugin alone is not enough.

Optional configuration

See Configuration Guide for details on how to customize LiveDebugger to your needs.

Contributing

For those planning to contribute to this project, you can run a dev version of the debugger with the following commands:

It'll run the application declared in the dev/ directory with the library installed.

LiveReload is working both for .ex files and static files, but if some styles don't show up, try using this command

What's next

To learn about our upcoming plans and developments, please visit our discussion page.

Authors

LiveDebugger is created by Software Mansion.

Since 2012 Software Mansion is a software agency with experience in building web and mobile apps as well as complex multimedia solutions. We are Core React Native Contributors, Elixir ecosystem experts, and live streaming and broadcasting technologies specialists. We can help you build your next dream product – Hire us.

Licensed under the Apache License, Version 2.0