https://github.com/nhedger/laravel-envicon
Display a custom favicon that depends on your runtime environment.
https://github.com/nhedger/laravel-envicon
environment favicon favicon-dynamic laravel laravel-package
Last synced: about 1 month ago
JSON representation
Display a custom favicon that depends on your runtime environment.
- Host: GitHub
- URL: https://github.com/nhedger/laravel-envicon
- Owner: nhedger
- License: mit
- Created: 2020-06-10T19:40:35.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-06-13T19:24:07.000Z (almost 2 years ago)
- Last Synced: 2025-03-26T13:01:35.761Z (about 2 months ago)
- Topics: environment, favicon, favicon-dynamic, laravel, laravel-package
- Language: PHP
- Homepage:
- Size: 105 KB
- Stars: 20
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Envicon
This package allows you to display a custom favicon depending on your
runtime environment. This makes it easy to identify immediately on which
environment you're browsing.
## Install
Via [Composer](https://getcomposer.org/)
```shell script
composer require hedger/laravel-envicon
```
Once the package is installed, you'll need to **publish the configuration**
to link your environments to custom favicons.
```shell script
php artisan vendor:publish --tag=envicon-config
```
If you want to use the default envicons provided by this package, run
the following command that will copy them in your `public/favicons`
folder.
```shell script
php artisan vendor:publish --tag=envicon-favicons
```
## Usage
Simply use the provided helper in place of your favicon's URL. This will
return the favicon that matches your current **runtime environment**.
```blade
```
If you need the URL of a favicon for a **specific environment**, use the
following statement instead. You'll need to pass the environment's name
as the first parameter.
```blade
```
## Testing
Tests can be run using the following composer script.
```shell script
composer test
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/hedger/laravel-envicon.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-build]: https://img.shields.io/github/workflow/status/nhedger/laravel-envicon/Test/master?style=flat-square
[screenshot]: .github/screenshot.png
[link-packagist]: https://packagist.org/packages/hedger/laravel-envicon