jithran / git-ribbon
A ribbon for laravel projects that gives information about the current git status of the project
Requires
- php: ^8.0
Requires (Dev)
- orchestra/testbench: ^8.5
README
Git Ribbon
A Laravel package that provides git status information
Documentation | Features | Installation | License
Git Ribbon is a Laravel package that creates a ribbon on the top of the page which gives information about the current status of the git work directory with a tooltip with project information. It helps developers to quickly understand the current git status without leaving the application. It's an easy reminder to commit and push the changes.
Features
- Displays if a project is up-to-date or not in a ribbon
- Provides git & environment information in a tooltip
- Easy to install and use
Requirements
- Laravel 10.x
- PHP 8.x
Installation
To install the package via composer, Run:
composer require jithran/git-ribbon --dev
The package will automatically register itself.
You can publish the config file with:
php artisan vendor:publish --provider="Jithran\GitRibbon\GitRibbonServiceProvider" --tag="config"
By default, the ribbon is only displayed in the local, dev or development environments (APP_ENV). You can change this in the config file by expanding the git-ribbon.environment array.
License
The MIT License (MIT). Please see License File for more information.