vulgar/repo

一个 Laravel 包,用于获取您的 GitHub 公共仓库并将 README 文件保存到数据库中,以便在网页上使用

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

This package is auto-updated.

Last update: 2024-09-16 03:36:29 UTC


README

简介

Vulgar 仓库包允许您设置您的 GitHub 用户名,获取您所有的公共仓库,并将它们的 README 文件存储在您的数据库中,以便在您的网站上显示。

安装

  1. 通过 Composer 安装包

    composer require vulgar/repo
  2. 发布配置文件

    php artisan vendor:publish --provider="Vulgar\Repo\Providers\RepoServiceProvider"
  3. .env 文件中设置您的 GitHub 用户名和令牌(对于私有仓库)

    GITHUB_USERNAME=your-github-username
    GITHUB_TOKEN=your-github-token
    REPO_CACHE_DURATION=3600
  4. 运行迁移

    php artisan migrate

使用方法

  • 运行以下命令以获取仓库及其 README 文件

    php artisan repo:fetch
  • 您也可以在控制器中使用此服务,它将在需要时填充并缓存仓库,存储时间由您的 env 文件中指定的时长决定。

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