atomicptr/flysystem-github-storage

A Github based filesystem for Flysystem.

v0.1.4 2024-09-19 15:47 UTC

This package is auto-updated.

Last update: 2024-09-19 15:50:00 UTC


README

A GitHub based filesystem for Flysystem, powered by php-github-api.

Note: Keep in mind that GitHub has a rate limit, so if you need a lot of file operations you might need something else.

Inspired by @RoyVoetman/flysystem-gitlab-storage.

Usage

<?php

use Atomicptr\FlysystemGithub\GithubAdapter;
use Atomicptr\FlysystemGithub\Credentials;
use Atomicptr\FlysystemGithub\Committer;
use League\Flysystem\Filesystem;

$adapter = new GithubAdapter(
    "username",
    "repository",
    branch: "master",
    credentials: Credentials::fromToken("token..."),
    committer: new Committer("Peter Developer", "peter@developer.tld"),
);

$filesystem = new Filesystem($adapter);

// see http://flysystem.thephpleague.com/api/ for full list of available functionality

Laravel

Check out my other repository: atomicptr/laravel-github-storage

License

MIT