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
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@
44
44
45
45
Welcome to the world of enhanced user monitoring with the groundbreaking `Laravel User Monitoring` package! Developed by the brilliant minds at `Binafy`, this innovative open-source solution is designed to empower Laravel developers and website administrators with invaluable insights into user activities.
46
46
47
-
Tracking user behavior and interactions is now made effortless, allowing you to understand better your users' engagement, preferences, and pain points. With its seamless integration into Laravel projects, this package opens up a realm of possibilities, enabling you to optimize user experiences, detect bottlenecks, and make data-driven decisions for your platform's success.
47
+
Tracking user behavior and interactions is now made effortless, allowing you to better understand your users' engagement, preferences, and pain points. With its seamless integration into Laravel projects, this package opens up a realm of possibilities, enabling you to optimize user experiences, detect bottlenecks, and make data-driven decisions for your platform's success.
48
48
49
49
Experience real-time monitoring like never before, as you access comprehensive analytics and visualize user interactions with ease. Please don't worry, your users' data is handled securely, respecting privacy while giving you the tools to improve your application's performance and user satisfaction.
50
50
@@ -107,7 +107,7 @@ After publishing, run the `php artisan migrate` command.
107
107
<aname="usage"></a>
108
108
## Usage
109
109
110
-
The `Laravel-User-Monitoring`, needs to use middleware, traits, etc ... and it's not hard, enjoys :)
110
+
The `Laravel-User-Monitoring` needs to use middleware, traits, etc, and it's not hard, enjoys :)
111
111
112
112
<aname="configuration"></a>
113
113
## Configuration
@@ -121,7 +121,7 @@ If you want to customize the routes, you can publish the route file with this co
After, you can go to the `routes/user-monitoring.php` file and customize the routes.
124
+
After that, you can go to the `routes/user-monitoring.php` file and customize the routes.
125
125
126
126
Also, if you want to change the route file name, you can go to the config file and change the `file_path`:
127
127
@@ -142,7 +142,7 @@ Also, if you want to change the route file name, you can go to the config file a
142
142
<aname="user-configuration"></a>
143
143
## User Configuration
144
144
145
-
You can config your user with the `user-monitoring.php` configuration file:
145
+
You can configure your user with the `user-monitoring.php` configuration file:
146
146
147
147
```php
148
148
'user' => [
@@ -184,7 +184,7 @@ You can config your user with the `user-monitoring.php` configuration file:
184
184
185
185
-`model`: If your user model exists in another place, you can change it to the correct namespace.
186
186
-`foreign_key`: You can set the user foreign_key name, like `customer_id`.
187
-
-`table`: You can write your users table name if is not `users.
187
+
-`table`: You can write your users table name if it is not `users.
188
188
-`guards`: The guards are used to authenticate.
189
189
-`foreign_key_type`: The foreign key type (uuid-ulid-id).
190
190
-`display_attribute`: The special attribute of the user that you want to show in views.
@@ -215,7 +215,7 @@ When you want to monitor all views of your application, you must follow below:
215
215
216
216
1. Publish the [Migrations](#publish)
217
217
218
-
2. Use `VisitMonitoringMiddleware` in Kernel.php, you can go to the `App/Http` folder and open the `Kernel.php` file and add `VisitMonitoringMiddleware` into your middleware for example:
218
+
2. Use `VisitMonitoringMiddleware` in Kernel.php. You can go to the `App/Http` folder and open the `Kernel.php` file and add `VisitMonitoringMiddleware` into your middleware, for example:
219
219
220
220
```php
221
221
use Binafy\LaravelUserMonitoring\Middlewares\VisitMonitoringMiddleware;
If you want to disable monitoring for specific pages you can go to `user-monitoring.php` that exists in the `config` folder and add pages into the `visit_monitoring` key:
241
+
If you want to disable monitoring for specific pages, you can go to `user-monitoring.php` that exists in the `config` folder and add pages into the `visit_monitoring` key:
242
242
243
243
```php
244
244
'visit_monitoring' => [
@@ -276,7 +276,7 @@ First, you need to go to the `user-monitoring` config file and highlight the day
276
276
],
277
277
```
278
278
279
-
After, you need to use [Task Scheduling](https://laravel.com/docs/10.x/scheduling) to fire-related command, so go to `app/Console/Kernel.php` and do like this:
279
+
After, you need to use [Task Scheduling](https://laravel.com/docs/scheduling) to fire-related command, so go to `app/Console/Kernel.php` and do like this:
280
280
281
281
```php
282
282
<?php
@@ -298,12 +298,12 @@ class Kernel extends ConsoleKernel
298
298
}
299
299
```
300
300
301
-
You can change `hourly` to `minute` or `second`, for more information you can read [Schedule Frequency Options](https://laravel.com/docs/10.x/scheduling#schedule-frequency-options).
301
+
You can change `hourly` to `minute` or `second`. For more information, you can read [Schedule Frequency Options](https://laravel.com/docs/scheduling#schedule-frequency-options).
302
302
303
303
<aname="turn-on-off"></a>
304
304
### Turn ON-OFF
305
305
306
-
Maybe you want to turn off visit monitoring for some or always, you can use configuration to turn it off:
306
+
Maybe you want to turn off visit monitoring for some or always; you can use the configuration to turn it off:
307
307
308
308
```php
309
309
'visit_monitoring' => [
@@ -329,7 +329,7 @@ The `Laravel-User-Monitoring` also has amazing views that you can use very easil
329
329
<aname="ajax-requests"></a>
330
330
### Ajax Requests
331
331
332
-
Maybe you may disable record visits for `Ajax` requests, you can use config to disable it:
332
+
Maybe you may disable record visits for `Ajax` requests. You can use config to disable it:
333
333
334
334
```php
335
335
'visit_monitoring' => [
@@ -415,9 +415,9 @@ class Product extends Model
415
415
}
416
416
```
417
417
418
-
Now when a product is read, created, updated, or deleted, you can see which users doing that.
418
+
Now, when a product is read, created, updated, or deleted, you can see which users are doing that.
419
419
420
-
If you want to disable some actions like created, you can use the config file:
420
+
If you want to disable some actions, like creation, you can use the config file:
0 commit comments