Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lcharette/uf_configmanager
Configuration Manager for UserFrosting V4
https://github.com/lcharette/uf_configmanager
userfrosting userfrosting-sprinkle
Last synced: 3 months ago
JSON representation
Configuration Manager for UserFrosting V4
- Host: GitHub
- URL: https://github.com/lcharette/uf_configmanager
- Owner: lcharette
- License: mit
- Created: 2016-12-10T17:43:53.000Z (about 8 years ago)
- Default Branch: 4.1
- Last Pushed: 2024-06-06T01:01:46.000Z (8 months ago)
- Last Synced: 2024-10-31T19:51:35.706Z (3 months ago)
- Topics: userfrosting, userfrosting-sprinkle
- Language: PHP
- Size: 703 KB
- Stars: 7
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Configuration Manager Sprinkle for [UserFrosting 5](https://www.userfrosting.com)
[![Donate][kofi-badge]][kofi]
[![Latest Version][releases-badge]][releases]
[![UserFrosting Version][uf-version]][uf]
[](LICENSE)
[![Build][build-badge]][build]
[![PHPStan][PHPStan-img]][PHPStan]
[![Codecov][codecov-badge]][codecov]
[![StyleCI][styleci-badge]][styleci]
[kofi]: https://ko-fi.com/A7052ICP
[kofi-badge]: https://img.shields.io/badge/Donate-Buy%20Me%20a%20Coffee-blue?logo=ko-fi&logoColor=white
[releases]: https://github.com/lcharette/UF_ConfigManager/releases
[releases-badge]: https://img.shields.io/github/release/lcharette/UF_ConfigManager.svg?include_prereleases&sort=semver
[uf-version]: https://img.shields.io/badge/UserFrosting->=%205.0-brightgreen.svg
[uf]: https://github.com/userfrosting/UserFrosting
[build]: https://github.com/lcharette/UF_ConfigManager/actions?query=workflow%3ABuild
[build-badge]: https://img.shields.io/github/actions/workflow/status/lcharette/UF_ConfigManager/Build.yml?branch=5.0&logo=github
[codecov]: https://codecov.io/gh/lcharette/UF_ConfigManager
[codecov-badge]: https://codecov.io/gh/lcharette/UF_ConfigManager/branch/5.0/graph/badge.svg
[styleci]: https://styleci.io/repos/76127967
[styleci-badge]: https://styleci.io/repos/76127967/shield?branch=5.0&style=flat
[PHPStan-img]: https://img.shields.io/github/actions/workflow/status/lcharette/UF_ConfigManager/PHPStan.yml?branch=5.0&label=PHPStan
[PHPStan]: https://github.com/lcharette/UF_ConfigManager/actions/workflows/PHPStan.yml
Configuration Manager sprinkle for [UserFrosting 5](https://www.userfrosting.com). Lets you edit UserFrosting configs from the interface.
# Help and Contributing
If you need help using this sprinkle or found any bug, feels free to open an issue or submit a pull request. You can also find me on the [UserFrosting Chat](https://chat.userfrosting.com/) most of the time for direct support.
# Installation
To install in your Sprinkle :
1. Add this package with Composer :
```
composer require lcharette/uf_configmanager "~4.1.0"
```
2. Edit your Sprinkle Recipe to include the ConfigManager as a Sprinkle dependency :
```
\UserFrosting\Sprinkle\ConfigManager\ConfigManager::class
```
3. Add Config Manager frontend assets dependencies :
```
npm i --save @lcharette/configmanager@~4.1.0
```
4. Add Config Manager & FormGenerator frontend entries to your webpack entries. Open `webpack.config.js` and add in `const sprinkles { ... }`:
```
FormGenerator: require('@lcharette/formgenerator/webpack.entries'),
ConfigManager: require('@lcharette/configmanager/webpack.entries'),
```
5. Run :
```
php bakery bake
```
# Working example
The `public/` directory serves as an example of ConfigManager. You can clone this repository and install as any UserFrosting 5 sprinkle :
1. `composer install`
2. `php bakery bake`
3. `php -S localhost:8080 -t public`
## Permissions
The migration will automatically add the `update_site_config` permission to the `Site Administrator` role. If it's not added automatically, you can run the `UserFrosting\Sprinkle\ConfigManager\Database\Seeds\SettingsPermissions` seed using the `php bakery seed` command or add it manually in the admin UI. To give access to the config UI to another user, simply add the `update_site_config` permission slug to that user role.
## Add link to the menu
The configuration UI is bound to the the `/settings` route. Simply add a link to this route where you want it. The checkAccess make it so it will appear only for users having the appropriate permission. For example, you can add the following to the sidebar menu :
```html
{% if checkAccess('update_site_config') %}
{{ translate("CONFIG_MANAGER.TITLE") }}
{% endif %}
```
## Adding custom config
Settings are separated by _topics_ in the UI. Each topic is represented by a file, located in `schema/config/`. Unlike normal schema files, all entries needs to be wrapped inside a `config` key. A `name` and `desc` top-level entry will allow to define the title and description of the topic.
```json
{
"name" : "SITE.CONFIG",
"desc" : "SITE.CONFIG.DESC",
"config": { ... }
}
```
For example, to add an entry for `site.title` text and `site.registration.enabled` checkbox option in a "UserFrosting Settings" topic :
```json
{
"name" : "SITE.CONFIG",
"desc" : "SITE.CONFIG.DESC",
"config": {
"site.title" : {
"validators" : {
"required" : {
"message" : "SITE.TITLE.REQUIRED"
}
},
"form" : {
"type" : "text",
"label" : "SITE.TITLE",
"icon" : "fa-comment"
}
},
"site.registration.enabled" : {
"validators" : {},
"form" : {
"type" : "checkbox",
"label" : "SITE.REGISTRATION.ENABLED"
}
}
}
}
```
> *NOTE* Only `.json` are accepted. `Yaml` schemas are cannot be used for now.
# License
By [Louis Charette](https://github.com/lcharette). Copyright (c) 2020, free to use in personal and commercial software as per the MIT license.