Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yieldstudio/symfony-spot-hit-notifier

Provides Spot-Hit integration for Symfony Notifier.
https://github.com/yieldstudio/symfony-spot-hit-notifier

notifier sms spot-hit symfony symfony-bundle

Last synced: about 2 months ago
JSON representation

Provides Spot-Hit integration for Symfony Notifier.

Awesome Lists containing this project

README

        

Spot-Hit Notifier
====================

Provides Spot-Hit integration for Symfony Notifier.

⚠️ Merged in Symfony core.
https://github.com/symfony/symfony/pull/39948

| Symfony Version | Package Version |
|-----------------|-----------------|
| ~5.1.0 | 0.0.2 |
| ^5.2 | ^1.0.0 |

Installation
-----------

```
composer require yieldstudio/symfony-spot-hit-notifier
```

#### Enable the Bundle

Add following line in `bundles.php`:

```php
YieldStudio\Notifier\SpotHit\SpotHitNotifierBundle::class => ['all' => true],
```

#### Enable the Spot-Hit transport

Add the `spothit` chatter in `config/packages/notifier.yaml`

````yaml
framework:
notifier:
texter_transports:
spothit: '%env(SPOTHIT_DSN)%'
````

#### DSN example

```
// .env file
SPOTHIT_DSN=spothit://TOKEN@default?from=FROM
```

where:
- `TOKEN` is your Spot-Hit API key
- `FROM` is the custom sender (3-11 letters, default is a 5 digits phone number)

Running the Tests
---------

Install the [Composer](http://getcomposer.org/) dependencies:

git clone https://github.com/YieldStudio/symfony-spot-hit-notifier.git
cd symfony-spot-hit-notifier
composer update

Then run the test suite:

composer test

## License

This bundle is released under the MIT license.