| .github | ||
| assets | ||
| bin | ||
| config | ||
| public | ||
| src | ||
| templates | ||
| tests | ||
| translations | ||
| var | ||
| .codecov.yml | ||
| .editorconfig | ||
| .env.dist | ||
| .github_changelog_generator | ||
| .gitignore | ||
| .php-cs-fixer.dist.php | ||
| CHANGELOG.md | ||
| composer.json | ||
| composer.lock | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| package.json | ||
| phpstan.neon | ||
| phpunit.xml.dist | ||
| README.md | ||
| SECURITY.md | ||
| symfony.lock | ||
| UPGRADING.md | ||
| webpack.config.js | ||
| yarn.lock | ||
Kimai - time-tracker
Kimai is a free, open source and online time-tracking software designed for small businesses and freelancers. It is built with modern technologies such as Symfony, Bootstrap, RESTful API, Doctrine, AdminLTE, Webpack, ES6 and many more.
Introduction
- Home - Kimai project homepage
- Blog - Read the latest news
- Documentation - Learn how to use Kimai
- Translations - Kimai in your language
- Migration - Import data from Kimai 1
Requirements
- PHP 7.4 or higher (PHP 8 supported, PHP 8.1 does not support LDAP yet)
- MariaDB or MySQL
- A webserver and subdomain
- PHP extensions:
gd,intl,json,mbstring,pdo,xsl,zip
About
This is the new version of the open source time tracker Kimai. It is stable and production ready, ships with many advanced features, including but not limited to:
JSON API, invoicing, data exports, multi-timer and punch-in punch-out mode, tagging, multi-user and multi-timezones, authentication via SAML/LDAP/Database, customizable role and team permissions, responsive and ready for your mobile device, user specific rates, advanced search & filtering, money and time budgets, reporting, support for plugins and many more.
Installation
- Recommended setup - with Git and Composer
- Docker - containerized
- Development - on your local machine
- 1-click installer - hosted environments
Updating Kimai
- Update Kimai - get the latest version
- UPGRADING guide - version specific steps
Plugins
- Plugin marketplace - find existing plugins here
- Developer documentation - how to create a plugin
Roadmap and releases
You can see a rough 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. The master branch is always deployable, release tags are only snapshots of the current development version.
Release versions will be created on a regular base (approx. one release every 2 months). Every code change, whether it's a new feature or a bugfix, will be done on the master branch. Kimai is actively developed in my spare time, I put my effort into the software instead of backporting changes.
Contributing
You want to contribute to this repository? This is so great! The best way to start is to open a new issue for bugs or feature requests or a discussion for questions, support and such.
In case you want to contribute, but you wouldn't know how, here are some suggestions:
- Spread the word: More user means more people testing and contributing to Kimai - which in turn means better stability and more and better features. Please vote for Kimai on platforms lie Slant, Product Hunt, Softpedia or AlternativeTo, you can tweet about it, share it on LinkedIn, reddit or any of your favorite social media platforms. Every little bit helps!
- Answer questions: You know the answer to another user's problem? Share your knowledge!
- Make a feature request: Something can be done better? Something essential missing? Let us know!
- Report bugs
- Contribute: You don't have to be programmer to help. The documentation and translation could use some love as well.
- Sponsor the project
There is one simple rule in our "Code of conduct": Don't be an ass!