alphaolomi/laravel-repman

Package for Repman.io API

v2.0.1-alpha 2023-03-09 12:39 UTC

README

Laravel Repman

GitHub Tests Action Status Latest Version on Packagist GitHub Code Style Action Status Total Downloads

Laravel Repman provides an expressive, fluent interface to Repman.io's services.

Repman.io is a private Composer repository manager. It allows you to host your own Composer repository and manage packages from it. It also allows you to mirror packages from Packagist.

Documentation

Documentation for Laravel Repman can be found on the Laravel Repman.

Documentation for Repman can be found on the Repman Docs.

Installation

You can install the package via composer:

composer require alphaolomi/laravel-repman

You can publish the config file with:

php artisan vendor:publish --tag="repman-config"

Getting Started

Create a account on Repman.io and get your API token.

Usage

Using the package is very simple, you just need to call the Repman facade and pass the required parameters.

use AlphaOlomi\Repman\Facades\Repman;

// Collection of organizations
$orgsCollection =  Repman::organizations()->list();

/** @var AlphaOlomi\Repman\DataObjects\Organization */
$org =  Repman::organizations()->create('org-name');

Testing

Uses Pest PHP testing framework

composer test

APIs

Organization

  • List all organizations
  • Create organization

Package

  • List all packages
  • Add package
  • Update package
  • Synchronize package
  • Remove package

Token

  • List all tokens
  • Generate token
  • Regenerate token
  • Delete token

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.