Skip to content

Latest commit

 

History

History
149 lines (112 loc) · 7.38 KB

README.md

File metadata and controls

149 lines (112 loc) · 7.38 KB
Raw
Leantime Logo

Leantime™

Leantime is a lean open source project management system for startups and innovators.
It's an alternative to ClickUp, Notion, and Asana.
https://leantime.io

License Badge Version Docker Hub Badge Discord Badge Crowdin

alt text



Features:

  • Task management using kanban boards, table and calendar views
  • Idea boards & idea kanban boards
  • Various research and strategy boards
  • Milestone management using Gantt charts
  • Timesheet management
  • Manage goals
  • Retrospectives
  • Project dashboards
  • Project reports
  • Wikis with the ability to embed documents
  • Multiple user roles
  • Two-Factor Authentication
  • LDAP integration
  • Integrations with Mattermost, Slack, Zulip, Discord
  • Export timesheets, tasks and milestones to CSV
  • File storage with AWS S3 or local file system
  • Adjust color scheme and logo
  • Available in 19 languages

Screenshots

alt text alt text alt text
alt text alt text alt text
alt text alt text alt text
alt text alt text alt text

System Requirements

  • PHP 8+
  • MySQL 5.7+
  • Apache or Nginx (IIS works with some modifications)

Installation (Production)

  • Download latest release package
  • Create an empty MySQL database
  • Upload entire directory to your server
  • Point your domain root to the public/ directory
  • Rename config/.env.sample to config/.env
  • Fill in your database credentials (username, password, host, dbname) in config/.env
  • Navigate to <yourdomain.com>/install
  • Follow instructions to install database and set up first user account

Installation (Development)

  • Install composer and npm
  • Clone repository to your local server
  • Create MySQL database
  • Run composer to load php dependencies
composer install

then

npm install

to load Javascript dependencies and finally run the grunt task to create the compiled js files

./node_modules/grunt/bin/grunt Build-All
  • Point your local domain to the public/ directory
  • Rename config/configuration.sample.php to config/configuration.php
  • Fill in your database credentials (username, password, host, dbname) in config/configuration.php
  • Navigate to <localdomain>/install
  • Follow instructions to install database and user account

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 80:80 --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

You can set any of the config variables in config/configuration.php when running the docker command.

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

Running Locally

For development, we use a dockerized development environment. You will need to have docker, docker compose, make, composer and npm installed. to run the application for development, 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 8080.

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 configuration of the development environment is found in .dev/.env, and is already seeded with the appropriate values. You should probably not be modifying this unless you plan to work on a feature for a specific integration. 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 connection

Update

  • Make sure to take a backup of your database and files
  • Replace all files in your directory with the updated version
  • If there were any database changes, the system will redirect your to <yourdomain.com>/update

LICENSE Exceptions

This file forms part of the Leantime Software for which the following exception is added: Plugins within the /app/plugins directory which merely make function calls to the Leantime Software, and for that purpose include it by reference shall not be considered modifications of the software.

Support