edh649/crowdox-laravel

Laravel wrapper for edh649/crowdox package

v0.4 2023-06-12 15:41 UTC

This package is auto-updated.

Last update: 2024-11-12 18:52:54 UTC


README

This package provides integration with edh649's unofficial PHP library for the unofficial CrowdOx API.

The package simply provides a CrowdOx facade that acts as a wrapper to the edh649/crowdox package.

Configuration

php artisan vendor:publish --provider="edh649\CrowdOxLaravel\Providers\CrowdOxServiceProvider"` to publish the configuration files

Set your configuration using environment variables, either in your .env file or on your server's control panel:

  • CROWDOX_USERNAME

The username for the authenticating account.

  • CROWDOX_PASSWORD

The password for the authenticating account.

  • CROWDOX_DRIVER (Optional)

Set this to null or log to prevent calling the CrowdOx API directly from your environment.

Usage

Facade

The CrowdOx facade acts as a wrapper. Any methods available on this class (documentation here) are available through the facade. for example:

// Get all projects
CrowdOx::projects()->all();

Thanks

Thanks to Huddle Digital for the outline of this package.

License

This package is available under the MIT license.