redbox/tracker

Real-time check the visitors on your Laravel installation.

v1.0 2020-05-31 11:08 UTC

This package is auto-updated.

Last update: 2024-06-08 23:48:49 UTC


README

badge.svg 68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6a6f686e6e796d6173742f726564626f782d747261636b65722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572 68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6a6f686e6e796d6173742f726564626f782d747261636b65722f6261646765732f636f7665726167652e706e673f623d6d6173746572 68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6a6f686e6e796d6173742f726564626f782d747261636b65722f6261646765732f6275696c642e706e673f623d6d6173746572

Redbox-tracker allows helps you to track visiting traffic to your Laravel website. New visitors along with their requests will be saved to the database.

Getting started

Prerequisites

We don't require much, but these are the minimum requirements for using Redbox-tracker.

  • PHP 7.3
  • Laravel 7 or higher

There is one additional requirement if you are contributing to this package. For development on the package itself, we require pdo_sqlite for testing.

Installation

The package can be installed using composer.

composer require redbox/tracker

The package will automatically register itself.

Publish configuration file:

php artisan vendor:publish --provider="Redbox\Tracker\Providers\TrackerServiceProvider"

Install the database tables:

php artisan migrate

Create a listener for new visitors in your project:

php artisan make:listener NewVisitorListener

In App\Providers\EventServiceProvider and update the $listen array with:

    protected $listen = [
        // --
        \Redbox\Tracker\Events\NewVisitorEvent::class => [
            \App\Listeners\NewVisitorListener::class,
        ]
        // --
    ];

In App\Listeners\NewVisitorListener you now have access to the visitor data from $event->visitor.

    /**
     * Handle the event.
     *
     * @param  object  $event
     * @return void
     */
    public function handle($event)
    {
        dd($event->visitor);
    }

Documentation

For more detailed information about how to use this package, I would like to send you to the project wiki.

Disclaimer

This project is inspired by Laravel Visitor Tracker. I created this version of this software because I need that functionality for a project of my own. This means I want all my dependencies for that projects 'Inhouse'.

Author

This package is created and maintained by Johnny Mast. For feature requests or suggestions you could consider sending me an e-mail.

Enjoy

Oh and if you've come down this far, you might as well follow me on Twitter. If you like this software please consider giving it a start rating on GitHub.

License

MIT License

Copyright (c) 2020 Johnny Mast

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.