Skip to content

Commit

Permalink
Additional Readme Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelfolaron committed Feb 18, 2025
1 parent a90c382 commit 0f9a831
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 21 deletions.
46 changes: 32 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,17 @@
<div align="center">
<a href="https://leantime.io"><img src="https://leantime.io/wp-content/uploads/2023/03/leantime_logo.png" alt="Leantime Logo" width="300"/></a>

### Leantime&reg; ###
# Leantime&reg;

Leantime is an open source project management system for non-project manager.<br />We combine strategy, planning and executing while making it easy for everyone on the team to use. Building with ADHD, dyslexia and autism in mind. <br />It's an alternative to ClickUp, Monday, or Asana. As simple as Trello but as feature-rich as Jira.<br />[https://leantime.io](https://leantime.io)<br />
⭐ If you find Leantime useful, please star us on GitHub! ⭐

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

💪 As simple as Trello but as feature-rich as Jira<br />
🔄 A perfect alternative to ClickUp, Monday, or Asana<br />
🌐 [https://leantime.io](https://leantime.io)<br />

<a href="https://trendshift.io/repositories/2264" target="_blank"><img src="https://trendshift.io/api/badge/repositories/2264" alt="Leantime%2Fleantime | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>

Expand Down Expand Up @@ -38,16 +46,27 @@ Leantime is an open source project management system for non-project manager.<br
| ![alt text](public/assets/images/Screenshots/dark.png "My Work") | ![alt text](public/assets/images/Screenshots/projectDashboard.png "Project Dashboard") | ![alt text](public/assets/images/Screenshots/table.png "Grouped To-Dos") |
|-------------------------------------------------------------------------|:------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------:|
| ![alt text](public/assets/images/Screenshots/kanban.png "Kanban Board") | ![alt text](public/assets/images/Screenshots/timeline.png "Tasks on timeline") | ![alt text](public/assets/images/Screenshots/calendar.png "Project Calendar") |
| ![alt text](public/assets/images/Screenshots/goals.png "Goals") | ![alt text](public/assets/images/Screenshots/docs.png "Documents & Wikis") | ![alt text](public/assets/images/Screenshots/timesheet.png "Timsheets") |
| ![alt text](public/assets/images/Screenshots/goals.png "Goals") | ![alt text](public/assets/images/Screenshots/docs.png "Documents & Wikis") | ![alt text](public/assets/images/Screenshots/timesheet.png "Timesheets") |

<br /><br />
### ❗System Requirements ###

* PHP 8.1+
* MySQL 8.0+
* PHP 8.2+
* MySQL 8.0+ or MariaDB 10.6+
* Apache or Nginx (IIS works with some modifications)
* PHP Extensions:
* * mysql, pdo_mysql, mbstring, GD, exif, pcntl, bcmath, opcache, ldap, zip, openssl, phar
* mysql
* pdo_mysql
* mbstring
* GD
* exif
* pcntl
* bcmath
* opcache
* ldap
* zip
* openssl
* phar
<br /><br />
### ️⚡️ Installation (Production) ###

Expand All @@ -74,7 +93,7 @@ Whilst the steps above are applicable to Internet Information Services (IIS), th
* Double click on the PHP handler mapping that is used by the site
* Click `Request Restrictions…`
* Click the `Verbs` tab
* In the `One of the following verbs` text box, add `,PATCH` - for example: `GET,HEAD,POST,PATCH`
* In the `One of the following verbs` text box, add `PATCH` - for example: `GET,HEAD,POST,PATCH`
* Click `OK`
* In the `Executable (optional)` text box, put a double quote character (``) at the start and at the end of the path to the `php-cgi.exe` file (_this isn't needed if the path doesn't have a space in it_)
* Click `OK`
Expand Down Expand Up @@ -178,7 +197,7 @@ For timesheets: <br />
* If there were any database changes, the system will redirect you to `<yourdomain.com>/update`

#### CLI
* Run `bin/leantime system:update`
* Run `php bin/leantime system:update`

#### Docker
* Before updating, make sure your mysql container was started using a mounted volume, otherwise your content will be deleted
Expand All @@ -204,32 +223,31 @@ 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
## 🫴 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.
<br />

### Bugs
### 🪲 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
### 🌏 Translations

We use (Crowdin)[https://crowdin.com/project/leantime](https://crowdin.com/project/leantime) to manage all of our translations. If you don't see a language please message us on Discord.


### Community Support ##
### 👥 Community Support

* Documentation [https://docs.leantime.io](https://docs.leantime.io)
* Community Chat [Discord](https://discord.gg/4zMzJtAq9z)
* File a bug report [https://github.com/Leantime/leantime/issues/new](https://github.com/Leantime/leantime/issues/new)
* Translations [https://crowdin.com/project/leantime](https://crowdin.com/project/leantime)
<br /><br />
## ⚖️ LICENSE Exceptions ##
## ⚖️ 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.
Expand Down
8 changes: 4 additions & 4 deletions app/Core/Support/CarbonMacros.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public function formatDateForUser(): \Closure
{
$mixin = $this;

return function () use ($mixin): String {
return function () use ($mixin): string {
return self::this()
->locale($mixin->userLanguage)
->setTimezone($mixin->userTimezone)
Expand All @@ -72,7 +72,7 @@ public function formatTimeForUser(): \Closure
{
$mixin = $this;

return function () use ($mixin): String {
return function () use ($mixin): string {
return self::this()
->setTimezone($mixin->userTimezone)
->locale($mixin->userLanguage)
Expand All @@ -91,7 +91,7 @@ public function format24HTimeForUser(): \Closure
{
$mixin = $this;

return function () use ($mixin): String {
return function () use ($mixin): string {
return self::this()
->setTimezone($mixin->userTimezone)
->locale($mixin->userLanguage)
Expand All @@ -110,7 +110,7 @@ public function formatDateTimeForDb(): \Closure
{
$mixin = $this;

return function () use ($mixin): String {
return function () use ($mixin): string {
return self::this()
->setTimezone($mixin->dbTimezone)
->locale($mixin->userLanguage)
Expand Down
2 changes: 1 addition & 1 deletion app/Core/UI/Theme.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use Leantime\Core\Configuration\AppSettings;
use Leantime\Core\Configuration\Environment;
use Leantime\Core\Events\DispatchesEvents;
use Leantime\Core\Events\EventDispatcher as EventDispatcher;
use Leantime\Core\Events\EventDispatcher;
use Leantime\Core\Language;
use Leantime\Domain\Auth\Services\Auth;
use Leantime\Domain\Setting\Repositories\Setting;
Expand Down
2 changes: 1 addition & 1 deletion app/Domain/Tickets/Services/Tickets.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
use Leantime\Domain\Setting\Repositories\Setting as SettingRepository;
use Leantime\Domain\Sprints\Services\Sprints as SprintService;
use Leantime\Domain\Tickets\Models\Tickets as TicketModel;
use Leantime\Domain\Tickets\Repositories\TicketHistory as TicketHistory;
use Leantime\Domain\Tickets\Repositories\TicketHistory;
use Leantime\Domain\Tickets\Repositories\Tickets as TicketRepository;
use Leantime\Domain\Timesheets\Repositories\Timesheets as TimesheetRepository;
use Leantime\Domain\Timesheets\Services\Timesheets as TimesheetService;
Expand Down
2 changes: 1 addition & 1 deletion app/Plugins
Binary file modified public/assets/images/Screenshots/mywork.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/images/Screenshots/table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0f9a831

Please sign in to comment.