https://github.com/m50/laravel-git-contributions-calendar

Allows rendering of a calendar in blade with your git contributions.
https://github.com/m50/laravel-git-contributions-calendar

blade cache calendar contributions git laravel tailwind

Last synced: 3 months ago
JSON representation

Allows rendering of a calendar in blade with your git contributions.

• Host: GitHub
• URL: https://github.com/m50/laravel-git-contributions-calendar
• Owner: m50
• License: mit
• Created: 2019-10-26T00:24:37.000Z (over 6 years ago)
• Default Branch: trunk
• Last Pushed: 2020-06-14T03:54:11.000Z (about 6 years ago)
• Last Synced: 2025-02-15T12:14:34.997Z (over 1 year ago)
• Topics: blade, cache, calendar, contributions, git, laravel, tailwind
• Language: PHP
• Size: 46.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Render Git contributions from Gitlab and/or Github in a Blade file

[![Latest Version on Packagist](https://img.shields.io/packagist/v/m50/laravel-git-contributions-calendar.svg?style=flat-square)](https://packagist.org/packages/m50/laravel-git-contributions-calendar)

[![Build Status](https://img.shields.io/travis/m50/laravel-git-contributions-calendar/master.svg?style=flat-square)](https://travis-ci.org/m50/laravel-git-contributions-calendar)

[![StyleCI](https://github.styleci.io/repos/217633811/shield?branch=master)](https://github.styleci.io/repos/217633811)

[![Total Downloads](https://img.shields.io/packagist/dt/m50/laravel-git-contributions-calendar.svg?style=flat-square)](https://packagist.org/packages/m50/laravel-git-contributions-calendar)

Allows rendering of a calendar in blade with your git contributions.

An example of what it can look like:

![Screenshot](images/screenshot.png)

## Install

First install the package and publish the files:

```sh

composer install m50/laravel-git-contributions-calendar

php artisan vendor:publish

```

Add the Service Provider:

```php

m50\GitCalendar\Providers\ContribCalendarServiceProvider::class,

```

## Usage

You will want to rely on caching, because of the roundtrip time for the requests.

It's important to add the schedules job:

```php

$schedule->job(new CacheEventData(app(GithubApi::class)))

    ->daily();

```

Then it's also recommended that where you are pulling the data (your controller

for example) to kick off a new queue job to re-cache the data:

```php

$data = Cache::get(

    'git-contrib-data',

    function () {

        $this->dispatch(new CacheEventData(app(GithubApi::class)));

        return new GitData();

    }

);

if (app()->environment('Production')) {

    $this->dispatch(new CacheEventData(app(GithubApi::class)));

}

```

*Note: The default view relies on [TailwindCSS](https://tailwindcss.com/).*

## Credits

* [Marisa Clardy](https://github.com/m50)