workos / workos-php-laravel
WorkOS PHP Library for Laravel
Installs: 563 749
Dependents: 0
Suggesters: 0
Security: 0
Stars: 13
Watchers: 13
Forks: 9
Open Issues: 0
Requires
- php: >=5.6.0
- workos/workos-php: ^v3.3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.15 || ^3.6
- phpunit/phpunit: ^5.7 || ^10.1
Suggests
- laravel/framework: For testing
This package is auto-updated.
Last update: 2023-09-04 22:59:41 UTC
README
The WorkOS library for Laravel provides convenient access to the WorkOS API from applications written in Laravel.
Documentation
See the API Reference for Laravel usage examples.
Installation
To install via composer, run the following:
composer require workos/workos-php-laravel
For Laravel 5.0-5.4, add the WorkOS ServiceProvider in your config/app.php
:
"providers" => array( // ... WorkOS\Laravel\WorkOSServiceProvider::class )
For Laravel 5.5 and up, 6.x and 7.x... you're all set!
Configuration
Create a WorkOS configuration file by running the following:
php artisan vendor:publish --provider="WorkOS\Laravel\WorkOSServiceProvider"
The package will need to be configured with your api key and project id.
By default, the package will look for a WORKOS_API_KEY
and WORKOS_CLIENT_ID
environment variable.
SDK Versioning
For our SDKs WorkOS follows a Semantic Versioning (SemVer) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.