leantime README

The project's README from github.com/Leantime/leantime. As one markdown file: README.md.

Leantime Logo

Leantime®

⭐ If you find Leantime useful, please star us on GitHub! ⭐

Leantime is an open source project management system for non-project managers.
We combine strategy, planning and execution while making it easy for everyone on the team to use.
Built with ADHD, dyslexia and autism in mind. 🧠

💪 As simple as Trello but as feature-rich as Jira
🔄 A perfect alternative to ClickUp, Monday, or Asana
🌐 https://leantime.io

A screenshot of Leantime's my work dashboard showing a few boxes with large metrics represnting todos complete, goals contributing to, scheduled todos. Also shows a day calendar with one task on it and a list of tasks grouped by Overdue, Due this week and Due Later

License Badge Docker Hub Badge Github Downloads Discord Badge Crowdin GitHub Sponsors

alt text



🚀 Features*

Task Management Project Planning Information/Knowledge Management Administration
Task management via
kanban boards, gantt, table, list and calendar views		 Project Dashboards, reports & status updates Wikis / Docs Easy installation
Unlimited subtasks and dependencies Goal & metrics tracking Idea Boards Multiple user roles and per project permissions
Milestone management Lean & Business Model Canvas Retrospectives Two factor authentication
Sprint Management SWOT Analysis canvas File Storage via S3 or local filesystem LDAP, OIDC integration
Timetracking & timesheets Risk Analysis Screen & webcam recording Extendable via plugins and API
... and more Comments/discussions on everything Integrates with Slack, Mattermost, Discord
... and more Available in over 20 languages
*yes, all of these features are included in the OSS version


📸 Screenshots

Screenshot of Leantime's my work dashboard but with a dark color scheme. All colors are darkened or reverted Screenshot of Leantime's project dashboard showing a project checklist that has the first box checked, the latest tasks (1 right now), a progress donut chart at 0% Screenshot of Leantime's todo screen in table format. Tasks are grouped by status where each Status has a different color
alt text Screenshot of Leantime's timeline or gantt feature showing a timeline with various milestone boxes different in length representing how long these take. Each milestone has a different color and they are connected with an arrow Screenshot of Leantime's personal calendar screen showing a month overview with a few tasks
alt text Screenshot of Leantime's wiki page showing one template article of a product requirements document formatted with lists and tables Screenshot of Leantime's timesheet feature with a table a one week overview and input boxes for each day. Tasks are organized in rows



❗System Requirements



️⚡️ Installation (Production)

There are two main ways to install LeanTime for production. The first of which is to install all needed pieces of the system locally. The second is to use the officially supported Docker image.

Local Production Installation

IIS Installation Notes

Whilst the steps above are applicable to Internet Information Services (IIS), there is an additional configuration change that may be required in IIS to ensure full functionality - you need to allow the PATCH method:

Note: You may need to repeat this when you upgrade PHP.

Production Installation via Docker

We maintain an official Docker image on dockerhub. To run the image enter your MySQL credentials and execute. You can pass in all the configuration variables from .env

docker run -d --restart unless-stopped -p 8080:8080 --network leantime-net \
-e LEAN_DB_HOST=mysql_leantime \
-e LEAN_DB_USER=admin \
-e LEAN_DB_PASSWORD=321.qwerty \
-e LEAN_DB_DATABASE=leantime \
-e [email protected] \
--name leantime leantime/leantime:latest

Unless you have a database defined somewhere else you should use our docker-compose file.

Once started you can go to <yourdomain.com>/install and run the installation script.

Important: If you are planning to use plugins you need to mount the plugin folder plugins:/var/www/html/app/Plugins and ensure the www-data user has access to it. Otherwise installation may fail or plugins will be removed after a restart

Docker Installation Notes

If you intend to place Leantime behind a reverse proxy (nginx, etc.) to handle custom domain name resolution and SSL offloading, you will need to set the following environment variable in docker

-e LEAN_APP_URL=https://yourdomain.com \



🤓 Installation (Development)

There are two ways to install a development setup of LeanTime. The first (but most technical) is to install all pieces of the system locally. The second (and preferred method) is to use a docker containerized development environment.

Local Development Installation

Development Installation via Docker

For development, we use a dockerized development environment. You will need to have docker, docker compose, make, composer, git and npm installed.

In order to build the development docker image, in the root of this repository, run a primer with

make clean build

afterwards, run

make run-dev

this will start the development server on port 5080.

The dev environment provides a MySQL server, mail server, s3 server, and should be good to go for your needs out of the box. The basic configuration of the development environment is already defined in the composer file. You can create .env file inside of config/.env to augment the base configuration by setting some of the configs out of sample.env). Important: Don't update the database information as this will disconnect the app from the docker database. The applications you get are as follows

Additionally, Xdebug is enabled, but you will have to modify your IDE key in the .dev/xdebug.ini file(or alternatively, on your IDE). You also need to have port 9003 temporarily open on your firewall so you can utilize it effectively. This is because connections from docker to the host will count as external inbound connections

Run Tests

Static Analysis make phpstan
Code Style make test-code-style (to fix code style automatically use make fix-code-style)
Unit Tests make unit-test
Acceptance Tests make acceptance-test
(requires docker)

You can test individual acceptance test groups directly using:
For api:
docker compose --file .dev/docker-compose.yaml --file .dev/docker-compose.tests.yaml exec leantime-dev php vendor/bin/codecept run -g api --steps
For timesheets:
docker compose --file .dev/docker-compose.yaml --file .dev/docker-compose.tests.yaml exec leantime-dev php vendor/bin/codecept run -g timesheet --steps

🏗 Update

Manual

CLI

Docker

Common Issues

Please refer to our documentation about common issues found when installing or updating Leantime

🔌 Extend Leantime

You can extend Leantime by:

🛟 Let us install it for you.

Hassle free installation service in your environments. We can do full installations, updates, configurations or plugin installations. See our Marketplace for details.

☁️ Not interested in hosting yourself? Let us do it for you

We offer managed hosting plans as well as a SaaS product so you can get all the benefits of Leantime without the hassle. Head to leantime.io for more information.

🤙 Need technical support?

We can help you set up Leantime in your environment and customize it to your needs. Our support plans are outlined on our website.

Please note: We currently only support the official Leantime docker compose and standard installations. We only offer support for the most recent version.

We do not offer support for Cloudron, Elestio, Turnkey, or other external distribution platforms sharing unofficial versions of Leantime.

🫴 Contributing

We're excited you are interested in contributing to Leantime. We want to make sure you have a great experience contributing to Leantime and that the new features you build will make it into core.

🪲 Bugs

Find an issue on Github (or create a new one) add your name to it or comment that you will be working on it. Once fixed, create a Pull Request.

New Features in Core

If you have an idea about new features please reach out to us on Discord. This is where we coordinate feature development and discuss whether core is the right place to add your new features (Plugins is the alternative).

🌏 Translations

Language files and translations are stored in app/Language/* . Once updates please create a Pull Request.

👥 Community Support



⚖️ LICENSE Exceptions

Leantime is licensed under AGPLv3. This file forms part of the Leantime Software for which the following exception is added: Plugins within the /app/Plugins directory which may contain plugins licensed under other licenses including our enterprise license.

leantime (Leantime/leantime)

Searching Database…

11.9K ·GitHub
Leantime
Что это такое?Leantime — это система управления проектами с открытым исходным кодом, рассчитанная на тех, кто не является профессиональным руководителем проектов. Она объединяет управление задачами, планирование и инструменты для работы со знаниями в одном месте. Система позиционирует себя как такая же простая, как Trello, но с такими же богатыми возможностями, как Jira, и прямо разработана с учётом СДВГ, дислексии и аутизма.
Это приложение, которое я устанавливаю на свой сервер, или облачный SaaS-сервис?И то и другое: можно развернуть его на своём сервере с помощью локального установщика или официального образа Docker либо вообще не заниматься хостингом и использовать управляемый хостинг и тарифы SaaS от Leantime через leantime.io.
Как его запустить?Для продакшена скачайте архив релиза, создайте базу данных MySQL, загрузите файлы, направьте домен на public/, заполните config/.env учётными данными БД и откройте /install. Либо используйте официальный образ Docker с docker-compose и тем же шагом /install.
Какой стек на сервере мне нужен?Вам нужны PHP 8.2+, MySQL 8.0+ или MariaDB 10.6+, Apache или Nginx, а также набор расширений PHP, например bcmath, cURL, GD, LDAP, mbstring и OpenSSL.
Есть ли подводные камни при установке, о которых стоит знать?При использовании Docker нужно подключить папку plugins и выдать пользователю www-data доступ к ней, иначе установка может сорваться, а плагины будут стираться при перезапуске. Кроме того, официальная поддержка охватывает только стандартную настройку через Docker или установщик, но не сторонние переупакованные сборки.
Работает ли оно на серверах Windows, а не только на Linux?Да. Помимо Apache и Nginx на Linux, Leantime официально поддерживает IIS на Windows, однако для IIS требуется дополнительный ручной шаг, чтобы разрешить HTTP-метод PATCH.
Почему Leantime создавали с учётом СДВГ, дислексии и аутизма?Команда проектировала интерфейс и рабочие процессы так, чтобы снизить когнитивную перегрузку для нейроотличных пользователей. Цель — сделать управление проектами доступным для тех, кому трудны жёсткие, линейные процессы традиционных инструментов управления проектами.
Какие функции входят в бесплатную версию с открытым исходным кодом?Все основные функции доступны бесплатно: режимы просмотра (канбан, диаграмма Ганта, таблица, календарь), спринты, контрольные точки, табели учёта времени, вики, доски идей, ретроспективы, SWOT-анализ и анализ рисков, хранение файлов в S3 или локально, двухфакторная аутентификация, LDAP/OIDC, а также расширяемость через плагины и API.
Можно ли интегрировать его с инструментами, которые уже использует моя команда?Да. Оно интегрируется со Slack, Mattermost и Discord для уведомлений, поддерживает LDAP/OIDC для аутентификации и предоставляет JSON-RPC API и систему плагинов для пользовательских расширений.
На скольких языках оно доступно?Leantime поставляется с переводами более чем на 20 языков. Языковые файлы хранятся в app/Language/, и сообщество может вносить в них свой вклад через пул-реквесты.
What are similar projects?openproject, focalboard, plane, planka, itsaplan, invoiceninja, zitadel, laravel-crm
Which topics is it in?gantt, strategy, jira, lean, openid-connect, two-factor-authentication, notion, ldap, kanban, calendar, project-management, mariadb
Creator
Leantime
Size
249.1 MB
Stars
11.9K
Updated
CommitOct 18Releasev3.12.0Oct 15
Age
11y
Commits · 90 Days