thepixelnurse / leantime Goto Github PK

Leantime®

Leantime is a strategic open source project management system for innovative companies and teams looking to go from start to finish. Built for the non-project manager, we combine the plans and the work while making it easy for everyone on the team to use.
It's an alternative to ClickUp, Monday, or Asana. As simple as Trello but as feature rich as Jira.
https://leantime.io

• Task management using kanban boards, table and calendar views + sprint management
• Subtask management & dependencies
• Idea boards & idea kanban boards
• Various research and strategy boards such as SWOT, Lean Canvas, Business Model Canvas, Empathy Maps & more
• Milestone management using Gantt charts
• Timesheet management + time tracking on tasks
• Manage goals
• Retrospectives
• Project dashboards and project updates
• Project reports
• Comments / Discussion
• Confetti
• Portfolio overview with project status
• Wikis (Docs) 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
• Easy installation
• Available in 19 languages

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

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 offically supported Docker image.

• 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

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.

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

• Clone repository to your local server
• Create MySQL database
• Run wbepack builder via make build-dev
• Point your local domain 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 <localdomain>/install
• Follow instructions to install database and user account

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

• Notes for Windows Environments:
  • Run all commands within the git bash terminal in order to utilize unix specific commands
  • If installing php from a zip file, make sure to configure php.ini It does not exist initially, so copy C:\php\php.ini-development to C:\php\php.ini. You will also need to edit php.ini in a text editor and enable all needed extentions for the build process. You can find these by running the make commands and looking for any extensions that error out as missing. You can enable them by seaching php.ini for the extension that will look like: ;extension=gd and removing the semicolon.

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

• http://localhost:8080 : leantime
• http://localhost:8081 : maildev - to check emails sent
• http://localhost:8082 : phpmyadmin(authentication leantime:leantime) to check the DB schema and data
• http://localhost:8083 : s3ninja - to check s3 uploads. You need to enable this in the .dev/.env file by enabling s3

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

• 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 you to <yourdomain.com>/update

• Execute ./updateLeantime.sh in the root of your leantime application

• Before updating, make sure your mysql container was started using a mounted volume, otherwise your content will be deleted
• Delete/Stop existing container
• Pull the latest docker image and rebuild using your compose file

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.

• Documentation https://docs.leantime.io
• Community Forum https://community.leantime.io
• Discussions on Discord
• File a bug report https://github.com/Leantime/leantime/issues/new
• Translations https://crowdin.com/project/leantime