Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamekun/kame-settings
This package provides the settings module for the _KAME_, a simple cms made with laravel, livewire and tailwind.
https://github.com/kamekun/kame-settings
cms laravel livewire tailwind tailwindcss
Last synced: 9 days ago
JSON representation
This package provides the settings module for the _KAME_, a simple cms made with laravel, livewire and tailwind.
- Host: GitHub
- URL: https://github.com/kamekun/kame-settings
- Owner: kamekun
- License: mit
- Created: 2022-01-14T20:39:49.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-29T16:18:12.000Z (over 2 years ago)
- Last Synced: 2024-10-10T13:08:10.946Z (29 days ago)
- Topics: cms, laravel, livewire, tailwind, tailwindcss
- Language: PHP
- Homepage: https://github.com/kamekun/kame
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# KaMe Settings
[](https://packagist.org/packages/kamekun/kame-settings)
[](https://packagist.org/packages/kamekun/kame-settings)
This package provides the settings module for the _KAME_, a simple cms made with laravel, livewire and tailwind.
### Requirements
PHP >= 7.3|8.0
Laravel >=7.X
### Installation
Install via composer:
```bash
composer require kamekun/kame-settings
```
### Publish
Publish config file.
```bash
php artisan vendor:publish --tag="Kamekun\\KameSettings\\KameSettingsServiceProvider"
```
### Configure
You can change the options of your app from `config/kame-settings.php` file
### Database
Create table for database Model
```bash
php artisan migrate
```
### Facade
```php
// Parameters: key, value
Setting::get('foo', 'default');
// Parameters: key, value, readOnly (optional, default false)
Setting::set('foo', 'default', true);
// Note: (ReadOnly attributes are for properties/configuration that shouldn't delete from the backend panel)
```
### Blade Directive
You can get the settings directly in your blade templates using the helper method or the blade directive like `@setting('foo')`
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
### Contributing
I am open to contributions to this package, and will do the best I can to maintain it over time.
Pull requests are welcome, and in fact encouraged. Right now there are no specific guidelines for a PR.
### Road Map
Some considerations for future versions:
- Add Support for caching Settings
- Add support for save / read settings from json file
### Credits and License
- [KaMekuN](https://github.com/kamekun)
- Taylor Otwell and co. for Laravel
- Caleb Porzio for livewire
- Adam Wathan for Tailwind labs
This project is licensed under the MIT License - see the [License File](LICENSE) for details