https://github.com/jithran/gitribbon
Simple Ribbon for making git changes visible
https://github.com/jithran/gitribbon
git laravel laravel-package
Last synced: 6 months ago
JSON representation
Simple Ribbon for making git changes visible
- Host: GitHub
- URL: https://github.com/jithran/gitribbon
- Owner: Jithran
- License: mit
- Created: 2023-07-23T19:43:26.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-11T12:02:46.000Z (almost 3 years ago)
- Last Synced: 2025-08-03T12:06:31.545Z (11 months ago)
- Topics: git, laravel, laravel-package
- Language: PHP
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
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:
```bash
composer require jithran/git-ribbon --dev
```
The package will automatically register itself.
You can publish the config file with:
```bash
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](LICENSE.md) for more information.