README

Painlessly sync your contacts and organizations between your Laravel application and the rest of your operational suite.

Relay is Alpha!

Relay is undergoing its initial, 'alpha' development phase. The core design of Relay, and its public API, is subject to change at any notice. This notice will remain until Relay hits its first stable version, v1.0.0.

Relay helps you to bootstrap your internal integrations by painlessly, bidirectionally, syncing the contacts and organizational accounts between your Laravel application and the rest of your operational suite.

Note: This is the core Relay repository. If you're looking to install a particular driver, checkout the Drivers section.

Contents

• What Problem does Relay Solve?
• Requirements
• Installation
  • Driver Installation
• General Usage
• Testing
• Changelog
• Contributing
• Security Vulnerabilities
• Credits
• License

What Problem does Relay Solve?

In the early stages (or frankly any stage) of a startup, the development team is often tasked with integrating the platform or application with different operational tools. Think CRMs, marketing automation suites, payment gateways etc.

Relay lets you, as a developer, focus on building the actual product instead of integrating time consuming, (and often poorly documented) third party APIs. By abstracting these service's APIs into plug-and-play driver packages, Relay simply observes the relevant Eloquent models of your application and tasks these drivers with updating the relevant service.

Requirements

Relay requires PHP ^8.0 or ^7.4, and Laravel ^8.0.

Installation

// TODO: Installation instructions, including locking the core Relay package

Driver Installation

// TODO: Driver Installation

General Usage

// TODO: General Usage, including reference to see each package's specific usage instructions

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Frank Dixon
• All Contributors

License

The MIT License (MIT). Please see License File for more information.