Skip to content

A Kimai 2 demo bundle for developers, who want to extend their time-tracking experience

License

Notifications You must be signed in to change notification settings

lsgIT-HH/DemoBundle

 
 

Repository files navigation

A Kimai 2 demo bundle

CI Status

A Kimai 2 plugin, which showcases some developer options within Kimai 2.

What's included?

  • a new System configuration
  • a new menu entry
  • a demo controller with a view and repository
  • a new permission
  • a theme event, adding a css rule for "magic color dots" (customers, projects, activities)
  • a new API method
  • a new invoice template (plus a new search path via bundle extension)
  • a new dashboard widget
  • a event subscriber to sort the bundle permissions in a new section (see user roles & permission screen)
  • a listener to attach new action items in the plugin screen
  • a meta field for timesheets
  • a user preference
  • a doctrine migration for creating a simple database
  • an installation command (that will be used for future database updates as well)

Demo configuration

You users could set a default value via local.yaml like this:

demo:
    some_setting: testing

But that should not be required, as they can change the configuration through the "System configuration" screen in Kimai.

Installation

First clone it to your Kimai installation plugins directory:

cd /kimai/var/plugins/
git clone https://github.com/Keleo/DemoBundle.git

Rebuild the cache:

cd /kimai/
bin/console kimai:reload -n

And install the database:

cd /kimai/
bin/console kimai:bundle:demo:install

Permissions

This bundle ships a new permission:

  • demo - show all demo options to the user

By default, it is assigned to each user with the role ROLE_SUPER_ADMIN.

Read how to assign this permission to your user roles in the permission documentation.

About

A Kimai 2 demo bundle for developers, who want to extend their time-tracking experience

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 82.2%
  • Twig 17.8%