Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sammyjo20/wagonwheel
☸️ Offer an online version of your Laravel emails to users.
https://github.com/sammyjo20/wagonwheel
email hacktoberfest laravel laravel-framework laravel-package
Last synced: about 1 month ago
JSON representation
☸️ Offer an online version of your Laravel emails to users.
- Host: GitHub
- URL: https://github.com/sammyjo20/wagonwheel
- Owner: Sammyjo20
- License: mit
- Archived: true
- Created: 2020-10-06T16:58:44.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-06T23:11:11.000Z (over 2 years ago)
- Last Synced: 2024-09-27T19:22:40.180Z (about 1 month ago)
- Topics: email, hacktoberfest, laravel, laravel-framework, laravel-package
- Language: PHP
- Homepage:
- Size: 109 KB
- Stars: 247
- Watchers: 6
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# ⚠️ 07/08/2022 This project has officially been abandoned
Thank you everyone for downloading Wagonwheel, however I am going to be formally abandoning the project.
> This is was a collaborative project with [Ryan Chandler](https://github.com/ryangjchandler). Please consider supporting him for the hard work he put into this package!
> Help support the maintenance of this package by [buying me a coffee](https://ko-fi.com/sammyjo20).
# Wagonwheel
**Offer an online version of your Laravel emails to users.**
[](//packagist.org/packages/sammyjo20/wagonwheel) [](//packagist.org/packages/sammyjo20/wagonwheel) [](//packagist.org/packages/sammyjo20/wagonwheel)
- Uses Laravel's built-in temporary signed URLs to create the URL for the online version. This means it's secured by your app's encryption key, as well as making it difficult to guess.
- Highly customisable.
- Easy to install.
- Supports Laravel 8
## Installation
1. Install Wagonwheel using composer with the command below:
```shell
composer require sammyjo20/wagonwheel
```
2. Publish the migrations
```shell
php artisan vendor:publish --tag=wagonwheel-migrations
```
3. Run the migrations
```shell
php artisan migrate
```
4. Add the "SaveForOnlineViewing" trait to **any** of your Mailables.
```php
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
use Sammyjo20\Wagonwheel\Concerns\SaveForOnlineViewing;
class BookingConfirmed extends Mailable
{
use Queueable, SerializesModels, SaveForOnlineViewing;
/**
* Build the message.
*
* @return $this
*/
public function build()
{
return $this->subject('Booking Confirmed 🎉')
->markdown('emails.bookings.confirmed');
}
}
```
## Configuration
If you would like to customise how Wagonwheel works. Run the following command to publish Wagonwheel's configuration file.
```shell
php artisan vendor:publish --tag=wagonwheel-config
```
*component_placement* - This configuration variable defines if the banner should be rendered at the start of the email content or at the end of the email content. The available values are **start** and **end**.
*message_expires_in_days* - This configuration variable defines how long Wagonwheel should keep the online version of an email in days. If you would like the online version of your emails to never expire, set this to 0. **The default is 30 days**.
## Customisation
If you would like to customise how the banner looks inside the email, just publish Wagonwheel's views with the following command.
```shell
php artisan vendor:publish --tag=wagonwheel-views
```
## Testing
Run all tests
```
composer test
```
Run a specific test
```
composer test-f [name of test method]
```
## Thanks
- Ryan Chandler (@ryangjchandler) helped out massively with some great code improvements and overall making Wagonwheel better!
- Gareth Thompson (@cssgareth) helped out with coming up with a cool name!