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
Copy file name to clipboardExpand all lines: README.md
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,12 @@ Nuxt module for Laravel Echo integration to get a seamless experience with appli
14
14
15
15
## Features
16
16
17
-
<!-- Highlight some of the features your module provide here -->
17
+
- Sanctum-based authentication
18
+
- CSRF cookie management for Private and Presence channels
19
+
- CSR-only mode
20
+
- TypeScript support
18
21
19
-
- ⛰ Foo
20
-
- 🚠 Bar
21
-
- 🌲 Baz
22
+
**Note:** Before using this module, make sure you have a [Laravel Echo](https://laravel.com/docs/11.x/broadcasting) server running and properly configured.
22
23
23
24
## Quick Setup
24
25
@@ -28,6 +29,21 @@ Install the module to your Nuxt application with one command:
28
29
npx nuxi module add nuxt-laravel-echo
29
30
```
30
31
32
+
Then provide the configuration in your `nuxt.config.js`:
33
+
34
+
```typescript
35
+
exportdefaultdefineNuxtConfig({
36
+
modules: ['nuxt-laravel-echo'],
37
+
38
+
echo: {
39
+
key: 'REPLACE_ME', // Your Laravel Echo app key
40
+
authentication: {
41
+
baseUrl: 'laravel.test', // Your Laravel app URL
42
+
},
43
+
},
44
+
})
45
+
```
46
+
31
47
That's it! You can now use Nuxt Laravel Echo in your Nuxt app ✨
0 commit comments