af9dea9226
* removed un-maintained docker file * update all packages * fix deprecations * only show one line descriptions for customer, projects and activities * allow to show export column in timesheet listing
81 lines
4.6 KiB
Markdown
81 lines
4.6 KiB
Markdown
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/kimai/images/master/repository-header.png" alt="Kimai logo">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/kevinpapst/kimai2/actions"><img alt="CI Status" src="https://github.com/kevinpapst/kimai2/workflows/CI/badge.svg"></a>
|
|
<a href="https://codecov.io/gh/kevinpapst/kimai2"><img alt="Code Coverage" src="https://codecov.io/gh/kevinpapst/kimai2/branch/master/graph/badge.svg"></a>
|
|
<a href="https://packagist.org/packages/kevinpapst/kimai2"><img alt="Latest stable version" src="https://poser.pugx.org/kevinpapst/kimai2/v/stable"></a>
|
|
<a href="https://packagist.org/packages/kevinpapst/kimai2"><img alt="License" src="https://poser.pugx.org/kevinpapst/kimai2/license"></a>
|
|
<a href="https://gitter.im/kimai2/support"><img alt="Gitter" src="https://badges.gitter.im/kimai2/support.svg"></a>
|
|
<a href="https://www.bountysource.com/teams/kimai2"><img alt="Bountysource" src="https://img.shields.io/bountysource/team/kimai2/activity"></a>
|
|
</p>
|
|
|
|
<h1 align="center">Kimai 2 - Time Tracker</h1>
|
|
|
|
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 etc.
|
|
|
|
## Introduction
|
|
|
|
- [Home](https://www.kimai.org) - Kimai project homepage
|
|
- [Blog](https://www.kimai.org/blog/) - Get the latest news
|
|
- [Documentation](https://www.kimai.org/documentation/) - Learn how to use Kimai
|
|
- [Translations](https://hosted.weblate.org/projects/kimai/#languages) - Kimai in your language
|
|
- [Migration](https://www.kimai.org/documentation/migration-v1.html) - Import data from v1
|
|
|
|
### Requirements
|
|
|
|
- PHP 7.2.9 or higher ([PHP 8 not yet](https://github.com/kevinpapst/kimai2/pull/2158))
|
|
- MariaDB or MySQL
|
|
- Webserver (nginx, Apache)
|
|
- Some PHP extensions, see [composer.json](composer.json) or [here](https://www.kimai.org/download/)
|
|
|
|
### About
|
|
|
|
This is the new version of the open source time tracker Kimai. It is stable and production ready, ships
|
|
with a lot of 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 permissions, responsive and ready for your mobile device,
|
|
user specific rates, advanced search & filtering, money and time budgets with 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
|
|
|
|
### Updating Kimai
|
|
|
|
- [Update Kimai](https://www.kimai.org/documentation/updates.html) - get the latest version
|
|
- [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.
|
|
> 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 4-8 weeks).
|
|
Every code change, whether it's a new feature or a bug fix, will be done on the master branch.
|
|
Kimai is actively developed in my spare time and I put my effort into the software instead of backporting changes for old versions.
|
|
The only exception is a critical security issue, which I would fix in the latest stable version as well.
|
|
|
|
## 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).
|