vulgar/repo

A Laravel package that fetches your GitHub public repositories and saves README files into db for use on web pages

dev-main 2024-05-16 02:43 UTC

This package is auto-updated.

Last update: 2024-10-16 03:51:08 UTC


README

Introduction

The Vulgar Repo package allows you to set your GitHub username, fetch all of your public repositories, and store their README files in your db for display on your website.

Installation

  1. Require the package via Composer:

    composer require vulgar/repo
  2. Publish the configuration file:

    php artisan vendor:publish --provider="Vulgar\Repo\Providers\RepoServiceProvider"
  3. Set your GitHub username and token (for private repos) in the .env file:

    GITHUB_USERNAME=your-github-username
    GITHUB_TOKEN=your-github-token
    REPO_CACHE_DURATION=3600
  4. Run the migration:

    php artisan migrate

Usage

  • Run the following command to fetch repositories and their README files:

    php artisan repo:fetch
  • You can also use the service in your controller, which will populate (when necessary) and store the repos in cache for the amount of time determined in your env file.

    $service = app(\Vulgar\Repo\Services\RepoService::class);
    $repos = $service->fetchRepositories();
    return view('repo.index', compact('repos'));