> For the complete documentation index, see [llms.txt](https://docs.opensoutheners.com/oss/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opensoutheners.com/oss/readme.md).

# Open Southeners Documentation

Documentation for Open Southeners open source libraries. Find installation guides, usage examples and a community to build with.

{% columns %}
{% column width="65%" %}
**OPEN SOUTHENERS · OPEN SOURCE BY UNIKIA**

## What we build, we share.

Practical libraries, useful tools and the docs to make them yours. Find an installation guide, explore an example, or help us make the next release better.

<a href="#find-your-building-block" class="button primary" data-icon="book-open">Explore the libraries</a> <a href="https://github.com/open-southeners" class="button secondary" data-icon="github">View on GitHub</a>
{% endcolumn %}

{% column width="35%" %}

<figure><img src="https://opensoutheners.com/images/radial-harmony.svg" alt="Open Southeners radial logo" width="220"><figcaption><p>Built to be used. Shared to be improved.</p></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

***

## Find your building block

Installation, configuration and examples for every documented library. Pick a project below, use the menu above, or search the docs.

### Laravel

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-brackets-curly">:brackets-curly:</i></td><td><strong>Laravel Apiable</strong></td><td>Build JSON:API responses with filtering, sorting, includes and pagination.</td><td><a href="https://docs.opensoutheners.com/oss/laravel-apiable/">https://docs.opensoutheners.com/oss/laravel-apiable/</a></td></tr><tr><td><i class="fa-arrows-left-right">:arrows-left-right:</i></td><td><strong>Laravel Data Mapper</strong></td><td>Turn arrays and JSON into structured data objects.</td><td><a href="https://docs.opensoutheners.com/oss/laravel-data-mapper/">https://docs.opensoutheners.com/oss/laravel-data-mapper/</a></td></tr><tr><td><i class="fa-magnifying-glass">:magnifying-glass:</i></td><td><strong>Scout Advanced Meilisearch</strong></td><td>Configure searchable indexes and work with Laravel Scout and Meilisearch.</td><td><a href="https://docs.opensoutheners.com/oss/laravel-scout-advanced-meilisearch/">https://docs.opensoutheners.com/oss/laravel-scout-advanced-meilisearch/</a></td></tr><tr><td><i class="fa-users-gear">:users-gear:</i></td><td><strong>Laravel SCIM</strong></td><td>Integrate SCIM provisioning into your Laravel application.</td><td><a href="https://docs.opensoutheners.com/oss/laravel-scim/">https://docs.opensoutheners.com/oss/laravel-scim/</a></td></tr><tr><td><i class="fa-mobile-screen">:mobile-screen:</i></td><td><strong>Laravel Companion Apps</strong></td><td>Connect your website and mobile apps with App Links, Universal Links and smart banners.</td><td><a href="https://docs.opensoutheners.com/oss/laravel-companion-apps/">https://docs.opensoutheners.com/oss/laravel-companion-apps/</a></td></tr><tr><td><i class="fa-hand-pointer">:hand-pointer:</i></td><td><strong>Laravel User Interactions</strong></td><td>Installation, configuration and usage for Laravel User Interactions.</td><td><a href="https://docs.opensoutheners.com/oss/laravel-user-interactions/">https://docs.opensoutheners.com/oss/laravel-user-interactions/</a></td></tr><tr><td><i class="fa-puzzle-piece">:puzzle-piece:</i></td><td><strong>Extended Laravel</strong></td><td>Explore the helpers and extensions in Extended Laravel.</td><td><a href="https://docs.opensoutheners.com/oss/extended-laravel/">https://docs.opensoutheners.com/oss/extended-laravel/</a></td></tr></tbody></table>

### PHP & JavaScript

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-scale-balanced">:scale-balanced:</i></td><td><strong>Byte Unit Converter</strong></td><td>Convert byte values into readable units. Documentation for 3.x and 2.x.</td><td><a href="https://docs.opensoutheners.com/oss/byte-unit-converter/">https://docs.opensoutheners.com/oss/byte-unit-converter/</a></td></tr><tr><td><i class="fa-brackets-curly">:brackets-curly:</i></td><td><strong>Extended PHP</strong></td><td>Explore the helpers and extensions in Extended PHP.</td><td><a href="https://docs.opensoutheners.com/oss/extended-php/">https://docs.opensoutheners.com/oss/extended-php/</a></td></tr><tr><td><i class="fa-link">:link:</i></td><td><strong>Flex URL</strong></td><td>Build and parse URLs, including Laravel Apiable query syntax.</td><td><a href="https://docs.opensoutheners.com/oss/flex-url/">https://docs.opensoutheners.com/oss/flex-url/</a></td></tr><tr><td><i class="fa-bolt">:bolt:</i></td><td><strong>Vue 3 Emitter</strong></td><td>Installation and usage for the Vue 3 event emitter.</td><td><a href="https://docs.opensoutheners.com/oss/vue-3-emitter/">https://docs.opensoutheners.com/oss/vue-3-emitter/</a></td></tr></tbody></table>

Looking for an older release? Use the version selector inside **Laravel Data Mapper** or **Byte Unit Converter** to open the matching documentation.

***

## A small install. A useful starting point.

{% tabs %}
{% tab title="Laravel · Composer" %}
Add JSON:API resources to a Laravel application.

```bash
composer require open-southeners/laravel-apiable
```

[Read the Laravel Apiable guide](https://docs.opensoutheners.com/oss/laravel-apiable/)
{% endtab %}

{% tab title="TypeScript · npm" %}
Start building and parsing URLs with Flex URL.

```bash
npm install flex-url
```

[Read the Flex URL guide](https://docs.opensoutheners.com/oss/flex-url/)
{% endtab %}
{% endtabs %}

***

## Good code brings people together.

The docs are one part of the project. Come for a question, stay to share an idea, or tell us what you’ve made.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-discord">:discord:</i></td><td><strong>Discord</strong></td><td>Talk code, ask questions and share what you’re building with the community.</td><td><a href="https://discord.gg/vXDG5MCNev">https://discord.gg/vXDG5MCNev</a></td></tr><tr><td><i class="fa-telegram">:telegram:</i></td><td><strong>Telegram</strong></td><td>Follow new releases, new packages and updates from Open Southeners.</td><td><a href="https://t.me/opensoutheners">https://t.me/opensoutheners</a></td></tr><tr><td><i class="fa-bullhorn">:bullhorn:</i></td><td><strong>Scenebits</strong></td><td>Our community for discovering, sharing and promoting open source projects.</td><td><a href="https://scenebits.es/">https://scenebits.es/</a></td></tr></tbody></table>

***

{% columns %}
{% column width="50%" %}

### Make the next version better.

A clear bug report, a corrected example or a small pull request can help everyone using a project. Start in the repository for the library you’re working with.

<a href="https://github.com/open-southeners" class="button secondary" data-icon="code-pull-request">Find a repository</a>
{% endcolumn %}

{% column width="50%" %}

### There’s more beyond the libraries.

Explore our desktop apps, developer tools and other open source work on the main website.

Open Southeners is the open source imprint of **Unikia**.

<a href="https://opensoutheners.com" class="button secondary" data-icon="arrow-up-right-from-square">Explore Open Southeners</a>
{% endcolumn %}
{% endcolumns %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.opensoutheners.com/oss/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
