| .github | ||
| assets | ||
| bin | ||
| config | ||
| public | ||
| src | ||
| templates | ||
| tests | ||
| translations | ||
| var | ||
| .editorconfig | ||
| .env.dist | ||
| .github_changelog_generator | ||
| .gitignore | ||
| .php_cs.dist | ||
| .scrutinizer.yml | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| composer.json | ||
| composer.lock | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| package.json | ||
| phpunit.xml.dist | ||
| README.md | ||
| symfony.lock | ||
| UPGRADING.md | ||
| webpack.config.js | ||
| yarn.lock | ||
Kimai 2 - Time-tracking made easy
Kimai - the open source time-tracker application with a mobile-first approach (read more at the official website).
Introduction
This is the reloaded version of the open source timetracker Kimai. It is built from scratch and doesn't share any source code with its predecessor. But it adapts the same ideas and a clean & simple UI for your time-tracking experience.
By now it is in an pre-stable development phase, usable and with most advanced features from Kimai 1. You can even import your data and start testing and using it today.
Kimai is a multi-language application and already translated to english, german, italian, french, spanish, russian, arabic, hungarian and portuguese.
Requirements
- PHP 7.1.3 or higher (test your system compatibility with the requirements-checker)
- The PHP extensions intl, zip and PDO with either pdo_sqlite or pdo_mysql enabled
- If you use MariaDB, make sure its at least v10.2.7 (see FAQ)
- Kimai needs to be installed in the root directory of a domain or you need to recompile the frontend assets
- A modern browser, Kimai v2 might be broken on old browsers like IE 10
Documentation
Looking for more information about Kimai 2? Check out our detailed documentation.
Installation
There are multiple ways to install Kimai, all of them described in the installation docu:
Updating Kimai
Read the following documentations before you start your upgrade:
- The update documentation
- The version specific UPGRADING guide
- The release information
Roadmap and releases
You can see our development roadmap in the Milestones sections. It is open for changes and input from the community, your ideas and questions are welcome!
Kimai 2 uses a rolling release concept for delivering updates. You can upgrade Kimai at any time, you don't need to wait for the next official release.
Release versions will be created on a regular base and you can use these tags if you are familiar with Git, but we will not provide support for any specific version. Every code change, whether it's a new feature or a bug fix, will be done on the master branch and intensively tested before merging. We have to do it this way, as we develop Kimai in our free time and want to put our effort into the software instead of backporting changes for old versions.
Extensions for Kimai 2
As Kimai 2 was built on top of Symfony, it can be extended like every other Symfony application. We call these extensions bundles, but you might also know them as add-ons, extensions or plugins.
All available Kimai 2 bundles can be found at the Kimai recipes repository.
Developer
Kimai 2 is developed with modern frameworks like Symfony v4, Doctrine, AdminLTE and many more.
If you want to start developing for Kimai 2, please read the following documentation:
- an example on how to extend Kimai 2 can be found in this GitHub repository
- the developer documentation is available both on GitHub and your local installation