Stickle

Appearance

Installation ​

Prerequisites ​

Stickle requires:

  • PHP 8.2+
  • Laravel 12.0+.

Installing Stickle ​

Step 1: Require via Composer ​

Use Composer to require Stickle into your Laravel project:

bash
composer require stickleapp/core

Step 2: Run the Installer ​

Stickle provides an installer that will guide you through configuration. Run it via artisan:

bash
php artisan stickle:install

The installer will:

  • Publish configuration files
  • Run database migrations
  • Set up default tracking options

Step 3: Run Migrations ​

Migrations are typically run by the installer, but you can run them manually if needed:

bash
php artisan migrate

Step 4: Install Laravel Reverb (Optional) ​

If you want real-time features like live event streaming and real-time UI updates, install Laravel Reverb as your websockets server:

bash
php artisan install:broadcasting

This command will:

  • Install the Laravel Reverb package
  • Publish Reverb configuration files
  • Configure broadcasting in your application

For more details, see the Laravel Reverb documentation.

Advanced Installation ​

The following are handled by the stickle:install command but you may need to run them independently at some point.

Publish Files ​

You must manually publish files from Stickle to your project.

$ php artisan vendor:publish --provider="StickleApp\Core\CoreServiceProvider"

Configuration ​

Stickle ships with sensible defaults that work with most 'out-of-the-box' Laravel installations.

The stickle:install artisan command will publish /config/stickle.php and setup your initial values.

You can manually configure these settings if necessary.

Migrations ​

The stickle:install command will run the required migrations automatically. If you need to run them manually:

bash
php artisan migrate

Running Stickle ​

Once installed, Stickle requires background services to be running.

Queue Worker ​

Stickle processes jobs asynchronously via Laravel's queue system. During development, run:

bash
php artisan queue:work

For production, configure a process monitor like Supervisor to keep the queue worker running. See the Laravel Queue documentation for details.

Scheduled Tasks ​

Stickle runs several scheduled tasks in the background to process analytics data. During development, run:

bash
php artisan schedule:work

For production, configure your server's cron to run Laravel's scheduler. Add this to your crontab:

bash
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

Laravel Reverb (Optional) ​

If you want real-time features (live event streaming, real-time UI updates), start Laravel Reverb. For development:

bash
php artisan reverb:start

For production, run Reverb as a background service. See the Laravel Reverb documentation for details.

Next Steps ​

You're now ready to start using Stickle! Here's what to do next:

For deployment to production, see our Deployment Guide.