You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
LiveDebugger is a browser-based tool for debugging applications written in [Phoenix LiveView](https://github.com/phoenixframework/phoenix_live_view) - an Elixir library designed for building rich, interactive online experiences with server-rendered HTML.
4
5
@@ -8,10 +9,14 @@ Designed to enhance your development experience LiveDebugger gives you:
8
9
-:mag: The ability to inspect assigns for LiveViews and LiveComponents
> LiveDebugger should not be used on production - make sure that the dependency you've added is `:dev` only
12
17
13
-
## Installation
14
18
19
+
### Mix installation
15
20
Add `live_debugger` to your list of dependencies in `mix.exs`:
16
21
17
22
```elixir
@@ -32,19 +37,20 @@ For full experience we recommend adding below line to your application root layo
32
37
</head>
33
38
```
34
39
35
-
After you start your application LiveDebugger will be running at a default port `http://localhost:4007`.
40
+
After you start your application, LiveDebugger will be running at a default port `http://localhost:4007`.
36
41
37
-
> [!WARNING]
38
-
> LiveDebugger should not be used on production! Make sure that the dependency you've added is `:dev` only
42
+
### Igniter installation
39
43
40
-
## Browser features
44
+
LiveDebugger has [Igniter](https://github.com/ash-project/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.
41
45
42
-
List of browser features:
46
+
```bash
47
+
mix igniter.install live_debugger
48
+
```
43
49
44
-
- Debug button
45
-
- Components highlighting (coming soon!)
46
50
47
-
Some features require injecting JS into the debugged application. You can disable them in your config.
51
+
## Optional configuration
52
+
### Browser features
53
+
Some features require injecting JS into the debugged application. They are enabled by default, but you can disable them in your config.
48
54
49
55
```elixir
50
56
# config/dev.exs
@@ -68,25 +74,15 @@ In `router.ex` of your Phoenix app, make sure your locally running Phoenix app c
LiveDebugger has [Igniter](https://github.com/ash-project/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.
74
-
75
-
```bash
76
-
mix igniter.install live_debugger
77
-
```
78
-
79
-
Make sure that added dependency is `:dev` only.
80
-
81
-
## Optional configuration
77
+
### Other
82
78
83
79
```elixir
84
80
# config/dev.exs
85
81
86
82
config :live_debugger,
87
83
ip: {127, 0, 0, 1}, # IP on which LiveDebugger will be hosted
88
84
port:4007, # Port on which LiveDebugger will be hosted
89
-
secret_key_base:<SECRET_KEY_BASE>, # Secret key used for LiveDebugger.Endpoint
85
+
secret_key_base:"YOUR_SECRET_KEY_BASE", # Secret key used for LiveDebugger.Endpoint
90
86
signing_salt:"your_signing_salt", # Signing salt used for LiveDebugger.Endpoint
91
87
adapter:Bandit.PhoenixAdapter# Adapter used in LiveDebugger.Endpoint
92
88
tracing_setup_delay:0# Time in ms after tracing will be initialized. Useful in case multi-nodes envs
0 commit comments