https://github.com/amethyst-php/config

Customize Laravel configuration using the database
https://github.com/amethyst-php/config

amethyst amethyst-package api config laravel utility

Last synced: about 1 month ago
JSON representation

Customize Laravel configuration using the database

• Host: GitHub
• URL: https://github.com/amethyst-php/config
• Owner: amethyst-php
• License: mit
• Created: 2018-05-16T15:09:00.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-29T15:32:11.000Z (about 2 years ago)
• Last Synced: 2025-10-12T19:32:31.359Z (8 months ago)
• Topics: amethyst, amethyst-package, api, config, laravel, utility
• Language: PHP
• Homepage:
• Size: 129 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Config

[![Action Status](https://github.com/amethyst-php/config/workflows/test/badge.svg)](https://github.com/amethyst-php/config/actions)

[![Amethyst](https://img.shields.io/badge/package-Amethyst-7e57c2)](https://github.com/amethyst-php/amethyst)

Customize Laravel configuration using the database. 

# Requirements

- PHP from 7.2 to 7.4

- Laravel from 5.8 to 8.x

## Installation

You can install it via [Composer](https://getcomposer.org/) by typing the following command:

```bash

composer require amethyst/config

```

The package will automatically register itself.

## Usage

A simple usage looks like this

```php

app('amethyst')->get('config')->createOrFail([

    'key' => 'app.name',

    'value' => 'My Application'

]);

```

There are only 2 attributes (`key` and `value`) and the validation is pretty basic.

When the ServiceProvider is booted or when a new record is saved, all records will be merged with the current configuration. This means you can override the current laravel configuration or create your own.

The attribute `key` works with dot notation too, so key can be also for e.g. `app.name`.

Keep in mind that this is an [Amethyst Package](https://github.com/amethyst-php/amethyst), if you wish to see the full list of available features and customization please check [core](https://github.com/amethyst-php/core)

## Api

There are no additional routes in this package, only the default provided by the [core](https://github.com/amethyst-php/core).

## Testing

- Clone this repository

- Copy the default `phpunit.xml.dist` to `phpunit.xml`

- Change the environment variables as you see fit

- Launch `./vendor/bin/phpunit`