Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ryangjchandler/filament-feature-flags

Control your Laravel feature flags through a clean Filament interface.
https://github.com/ryangjchandler/filament-feature-flags

Last synced: about 1 month ago
JSON representation

Control your Laravel feature flags through a clean Filament interface.

Host: GitHub
URL: https://github.com/ryangjchandler/filament-feature-flags
Owner: ryangjchandler
License: mit
Archived: true
Created: 2022-04-06T19:51:36.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-01-07T23:25:38.000Z (5 months ago)
Last Synced: 2024-01-10T18:25:43.261Z (5 months ago)
Language: PHP
Size: 731 KB
Stars: 47
Watchers: 1
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md

Lists

awesome-filament - ryangjchandler/filament-feature-flags - Control your Laravel feature flags through a clean Filament interface. (Complete Sections)

README

        # Control your Laravel feature flags through a clean Filament interface.

[![Latest Version on Packagist](https://img.shields.io/packagist/v/ryangjchandler/filament-feature-flags.svg?style=flat-square)](https://packagist.org/packages/ryangjchandler/filament-feature-flags)

[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/ryangjchandler/filament-feature-flags/run-tests?label=tests)](https://github.com/ryangjchandler/filament-feature-flags/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/ryangjchandler/filament-feature-flags/Check%20&%20fix%20styling?label=code%20style)](https://github.com/ryangjchandler/filament-feature-flags/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/ryangjchandler/filament-feature-flags.svg?style=flat-square)](https://packagist.org/packages/ryangjchandler/filament-feature-flags)

This packages provide a graphical wrapper around [ryangjchandler/laravel-feature-flags](https://github.com/ryangjchandler/laravel-feature-flags).

## Installation

You can install the package via Composer:

```bash

composer require ryangjchandler/filament-feature-flags

```

You should also follow the [installation instructions for underlying package](https://github.com/ryangjchandler/laravel-feature-flags#installation);

## Usage

Once installed, this package will register a new "Features" resource.

![Empty resource](art/empty-resource.png)

### Adding a new flag

To add a new flag, click the "Add Feature" button and you'll be presented with a form.

![Empty create form](art/create-form.png)

The _only_ required field in the form is the "Name" field. The "Description" field is optional and only serves as metadata for users.

You can toggle the value of flag by switching the toggle input labelled "Enabled".

#### Scoping a flag to a resource / model

> You should follow the [documentation on setting up models for feature flags](https://github.com/ryangjchandler/laravel-feature-flags#model-flags) before continuing.

Being by implementing the `RyanChandler\FilamentFeatureFlags\Contracts\FlaggableResource` interface on your chosen `Resource` class.

```php

use RyanChandler\FilamentFeatureFlags\Contracts\FlaggableResource;

class CustomerResource extends Resource implements FlaggableResource

{

    public static function getFlaggableRecordDisplayColumn(): string

    {

        return 'name';

    }

}

```

The `getFlaggableRecordDisplayColumn()` method should return the name of the column you'd like to display when searching for your flaggable records.

Now that you've implemented the `FlaggableResource` interface, you should be able to see your resource show up as an option in the "Resource Type" field.

![Resource type](art/resource-type.png)

If you select the resource, you'll see a new "Resource" field appear underneath. This field is a searchable `Select` field and can be used to search for and choose the record this flag is associated with.

![Resource searching](art/resource-searching.png)

Once you've selected a record, save the feature flag and it will be associated with it.

### Table

The table will show all flags, including flags associated with models / resources.

![Table overview](art/table.png)

The "Name" field is searchable and the "Enabled" column can be clicked to toggle the flag.

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Ryan Chandler](https://github.com/ryangjchandler)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.