74 lines
4.0 KiB
Markdown
74 lines
4.0 KiB
Markdown
# Kimai 2 - online time-tracker
|
|
|
|
[](https://packagist.org/packages/kevinpapst/kimai2)
|
|
[](https://packagist.org/packages/kevinpapst/kimai2)
|
|
[](https://travis-ci.org/kevinpapst/kimai2)
|
|
[](https://codecov.io/gh/kevinpapst/kimai2)
|
|
[](https://gitter.im/kimai2/support)
|
|
|
|
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, responsive and mobile-ready etc.
|
|
|
|
## Introduction
|
|
|
|
- [Home](https://www.kimai.org) - The house of Kimai
|
|
- [Blog](https://www.kimai.org/blog/) - Get the latest news
|
|
- [Documentation](https://www.kimai.org/documentation/) - Learn how to use
|
|
- [Translations](https://www.kimai.org/documentation/translations.html) - Kimai in your language
|
|
- [Migration](https://www.kimai.org/documentation/migration-v1.html) - Import data from v1
|
|
|
|
### Requirements
|
|
|
|
- PHP 7.2 or higher
|
|
- Database (MySQL, MariaDB, SQLite)
|
|
- Webserver (nginx, Apache)
|
|
- A modern browser
|
|
- [Other libraries](https://www.kimai.org/download/)
|
|
|
|
### About
|
|
|
|
This is new version of the open source timetracker Kimai. It is in a stable development phase, usable in production and
|
|
with most advanced features from Kimai 1 and many new ones, including but not limited to:
|
|
|
|
JSON API, invoicing, data exports, multi-timer and punch-in punch-out mode, tagging, multi-user and multi-timezones,
|
|
LDAP and built-in authentication, customizable role permissions, responsive and ready for your mobile device,
|
|
hourly and fixed rates, advanced filtering, money and time budgets and report, support for plugins and many more.
|
|
|
|
## Installation
|
|
|
|
- [Recommended setup](https://www.kimai.org/documentation/installation.html#recommended-setup) - with Git and Composer
|
|
- [Docker](https://www.kimai.org/documentation/docker.html) - containerized
|
|
- [Development](https://www.kimai.org/documentation/installation.html#development-installation) - on your local machine
|
|
- [1-click installer](https://www.kimai.org/documentation/installation.html#hosting-and-1-click-installations) - hosted environments
|
|
- [FTP](https://www.kimai.org/documentation/installation.html#ftp-installation) - unfortunately still widely used ;-)
|
|
|
|
### Updating Kimai
|
|
|
|
- [Update Kimai](https://www.kimai.org/documentation/updates.html) - the documentation
|
|
- [UPGRADING guide](UPGRADING.md) - version specific steps
|
|
|
|
### Plugins
|
|
|
|
- [Plugin marketplace](https://www.kimai.org/store/) - find existing plugins here
|
|
- [Developer documentation](https://www.kimai.org/documentation/developers.html) - how to create a plugin
|
|
|
|
## Roadmap and releases
|
|
|
|
You can see a rough development roadmap in the [Milestones](https://github.com/kevinpapst/kimai2/milestones) sections.
|
|
It is open for changes and input from the community, your [ideas and questions](https://github.com/kevinpapst/kimai2/issues) 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 (approx. every second month) and you can use these tags if you are familiar with git.
|
|
Every code change, whether it's a new feature or a bug fix, will be done on the master branch.
|
|
I have to do it this way, as I develop Kimai in my free time and want to put my effort into the software instead of backporting changes for old versions.
|
|
|
|
## Credits
|
|
|
|
Kimai 2 is developed with modern frameworks like
|
|
[Symfony v4](https://github.com/symfony/symfony),
|
|
[Doctrine](https://github.com/doctrine/),
|
|
[AdminLTEBundle](https://github.com/kevinpapst/AdminLTEBundle/) (based on [AdminLTE theme](https://github.com/almasaeed2010/AdminLTE)) and
|
|
[many](composer.json) [more](package.json).
|