README

TEvo Harvester is a tool to populate your own local database tables with a cache of the Ticket Evolution API data. It allows you to very easily create, populate, and update tables with the cache-able API data and includes the ability to easily schedule for this data to be updated periodically.

This application can and should be separate from whatever project you are creating to utilize the data. This keeps the underlying technologies, dependencies, and requirements separate from your main project and allows you to update this project as necessary without affecting other projects you are building that utilize the data stored by this application.

Installation

You can install this project via composer:

composer create-project jwcobb/tevo-harvester /path/to/project --prefer-dist

Configuration

Edit the .env file to add your database info as well as your Ticket Evolution API credentials and any other necessary changes.

Run Database Migrations

Migrations are included to create any necessary tables. From the command line run

php artisan migrate

Scheduling Updates

TEvo Harvester Laravel Scheduler to run these commands automatically at preset times. Just be sure to add the Laravel Scheduler to your crontab.

Each Harvest already has a suggested update interval assigned to it, but using the Dashboard you can edit the schedule and even include URLs to ping before and after updates in case you wish to use a Dead Man’s Switch such as Pushmon or Dead Man’s Snitch to ensure your updates are running as desired.

Manually Running Updates

Updates of the API information can be run either via the Dashboard or via command line using the artisan console with a command such as

php artisan harvester:update performers --action=active

Security Vulnerabilities

If you discover any security related issues, please email oss at jcobb dot org instead of using the issue tracker.

License

TEvo Harvester is open-sourced software licensed under the MIT license

jwcobb / tevo-harvester

Maintainers

Details