gourmet / dashboard
Dashboard plugin for CakePHP 3
Installs: 34
Dependents: 0
Suggesters: 0
Security: 0
Stars: 18
Watchers: 6
Forks: 5
Language:CSS
Type:cakephp-plugin
Requires
- cakephp/cakephp: 3.0.*-dev
- cakephp/plugin-installer: dev-master
- kriswallsmith/assetic: ~1.1
- leafo/scssphp: ~0.1
Requires (Dev)
- phpunit/phpunit: 4.1.*
This package is auto-updated.
Last update: 2024-10-28 01:40:02 UTC
README
Build beautiful dashboards for your cakes!
This is an unstable repository and should be treated as an alpha.
Requirements
- CakePHP 3.0.0 or greater.
- PHP 5.4.16 or greater
- SQLite or another database driver that CakePHP can talk to (defaults to SQLite).
Install
composer require gourmet/dashboard:*
or by adding this package to your project's composer.json
:
"require": {
"gourmet/dashboard": "*"
}
Now, enable the plugin in your bootstrap.php
(including bootstrap and routes):
Plugin::load('Gourmet/Dashboard', ['bootstrap' => true, 'routes' => true]);
You will also need to symlink the assets:
To preview the sample dashboard, you will need to also copy some sample widgets to your app:
That's it! You can now access the sample dashboard at: http://localhost/gourmet/dashboard/index
Documentation
Database Configuration
By default, Dashboard will store event data into a SQLite database in your application's tmp
directory. If
you cannot install pdo_sqlite, you can configure Dashboard to use a different database by defining a
gourmet_dashboard
connecting in your config/app.php
file.
Widgets
Built-in Widgets
There are several built-in widgets, they are:
- Clock
- Comments
- Graph
- Iframe
- Image
- List
- Meter
- Number
- Text
Configuration
There is no configuration at this time. Options will be coming soon.
Developing Your Own Widgets
You can create your own custom widgets for Gourmet/Dashboard. Until this is better documented, please refer to the sample widgets included.
Credits
- Shopify/dashing - the Sinatra application this plugin replicates
- cakephp/debug_kit - the SQLite implementation