Skip to main content

Quickstart

1) Install the package

composer require appkeep/laravel-appkeep

After the package is installed, run the following command to publish the config file.

php artisan appkeep:init

You are now ready to commit & deploy the changes to your server.

note

Execute the following steps on your production environment.

2) Set your project API key

Deploy the latest changes to your server. SSH into your server, go to your app directory and run the following command to log in:

php artisan appkeep:login

To test if everything's configured properly, run:

php artisan appkeep:run

3) Set up a cronjob

Make sure you have a cronjob that runs php artisan schedule:run every minute. App:keep relies on Laravel's scheduler. See Laravel's documentation to learn more.