54 lines
1.4 KiB
Markdown
54 lines
1.4 KiB
Markdown
# Kimai Heatmap Plugin
|
|
|
|
A GitHub-style activity heatmap for your [Kimai](https://www.kimai.org/) dashboard. See where your time went at a glance.
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- Calendar heatmap showing daily tracked hours over the past year
|
|
- Project filter dropdown
|
|
- Click any day to jump to that day's timesheet
|
|
- Streak counter and summary stats (total hours, daily average, busiest day)
|
|
- Weekend visual distinction
|
|
- Respects your configured start-of-week preference
|
|
- Works with light and dark themes
|
|
- Responsive — scrollable on small screens, resizes with the browser
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
composer config repositories.heatmap vcs https://git.toph.so/toph/kimai-plugin-heatmap
|
|
composer require kimai-plugin/heatmap-bundle
|
|
bin/console assets:install
|
|
bin/console kimai:reload
|
|
```
|
|
|
|
If you can't run `composer require` directly (e.g. Docker Compose, Nomad, or a custom image), add this to your `composer.json` instead:
|
|
|
|
```json
|
|
{
|
|
"repositories": [
|
|
{ "type": "vcs", "url": "https://git.toph.so/toph/kimai-plugin-heatmap" }
|
|
],
|
|
"require": {
|
|
"kimai-plugin/heatmap-bundle": "^1.0"
|
|
}
|
|
}
|
|
```
|
|
|
|
Then rebuild your image or run `composer install` in the container.
|
|
|
|
## Development
|
|
|
|
Requires [Nix](https://nixos.org/):
|
|
|
|
```bash
|
|
nix develop
|
|
process-compose up # starts MariaDB + Kimai
|
|
npm test # run JS tests
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|