Fleetbase Extensions Registry

Introduction

Welcome to the official source code repository for the Fleetbase Extensions Registry. This platform serves as a comprehensive package registry, catering to both Composer and npm packages, specifically tailored for Fleetbase extensions. Our unique focus on "Fleetbase Extensions" ensures a seamless integration and enhanced functionality for Fleetbase users.

Features

• Dual Package Support: Compatible with Composer and npm packages, offering a versatile solution for different development needs.
• Fleetbase Extensions Specialization: Dedicated support for Fleetbase-specific extensions, enhancing the Fleetbase ecosystem.
• Extension Validation: Each Fleetbase extension is required to include an extension.json file, ensuring standardization and quality control.

Getting Started

Prerequisites

• Docker and Docker Compose
• Basic understanding of Composer and npm package management

Installation

1. Clone the Repository:

   git clone git@github.com:fleetbase/registry.git
   

2. Set Up the Environment:

   sh install-plugins.sh
   

3. Build and Run with Docker Compose:

   docker-compose up --build
   

Configuration

Coming soon.

Usage

Publishing a Package

npm i -g flb-cli
flb-cli publish [my-extension]

Installing an Extension

Update composer.json

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://registry.fleetbase.io"
        }
    ]
}

Contributing

We welcome contributions to the Fleetbase Extensions Registry! Please read our CONTRIBUTING.md for guidelines on how to make a contribution.

Support and Contact

For support or inquiries, please open an issue.

License

This project is licensed under the APGLV v3 License - see the LICENSE.md file for details.