123 lines
4.3 KiB
Markdown
123 lines
4.3 KiB
Markdown
<h1 align="center">
|
|
<a href="https://worklenz.com" target="_blank" rel="noopener noreferrer">
|
|
<img src="https://app.worklenz.com/assets/icons/icon-144x144.png" alt="Worklenz Logo" width="75">
|
|
</a>
|
|
<br>
|
|
Worklenz
|
|
</h1>
|
|
|
|
<p align="center">
|
|
<a href="https://worklenz.com/features/task-management/">Task Management</a> |
|
|
<a href="https://worklenz.com/features/time-tracking/">Time Tracking</a> |
|
|
<a href="https://worklenz.com/features/analytics/">Analytics</a> |
|
|
<a href="https://worklenz.com/features/resource-management/">Resource Management</a> |
|
|
<a href="https://worklenz.com/features/templates/">Project Templates</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://worklenz.com" target="_blank">
|
|
<img
|
|
src="https://worklenz.s3.amazonaws.com/assets/screenshots/hero-view.png"
|
|
alt="Worklenz"
|
|
width="1200"
|
|
/>
|
|
</a>
|
|
</p>
|
|
|
|
Worklenz is a project management tool designed to help organizations improve their efficiency. It provides a
|
|
comprehensive solution for managing projects, tasks, and collaboration within teams.
|
|
|
|
## Features
|
|
|
|
- **Project Planning**: Create and organize projects, assign tasks to team members.
|
|
- **Task Management**: Break down projects into smaller tasks, set due dates, priorities, and track progress.
|
|
- **Collaboration**: Share files, leave comments, and communicate seamlessly with your team members.
|
|
- **Time Tracking**: Monitor time spent on tasks and projects for better resource allocation and billing.
|
|
- **Reporting**: Generate detailed reports on project status, team workload, and performance metrics.
|
|
|
|
## Tech Stack
|
|
|
|
This repository contains the frontend and backend code for Worklenz.
|
|
|
|
- **Frontend**: Built using Angular, with [Ant Design of Angular](https://ng.ant.design/docs/introduce/en) as the UI
|
|
library..
|
|
- **Backend**: Built using a custom TypeScript implementation of ExpressJS, with PostgreSQL as the database, providing a
|
|
robust, scalable, and type-safe backend.
|
|
|
|
## Requirements
|
|
|
|
- Node.js version v18 or newer
|
|
- Postgres version v15.6
|
|
- Redis version v4.6.7 (not used yet. setup only.)
|
|
|
|
## Getting started with Worklenz.
|
|
- Containerized Installation - Use docker to deploy Worklenz in production or development environments.
|
|
- Manual installation - To get started with Worklenz, please follow this guide [worklenz setup guidelines](SETUP_THE_PROJECT.md).
|
|
|
|
## Screenshots
|
|
|
|
<p align="center">
|
|
<a href="https://worklenz.com/features/task-management/" target="_blank">
|
|
<img
|
|
src="https://worklenz.s3.amazonaws.com/assets/screenshots/task-views-view.png"
|
|
alt="Worklenz task views"
|
|
width="1024"
|
|
/>
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://worklenz.com/features/time-tracking/" target="_blank">
|
|
<img
|
|
src="https://worklenz.s3.amazonaws.com/assets/screenshots/time-tracking-view.png"
|
|
alt="Worklenz time tracking"
|
|
width="1024"
|
|
/>
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://worklenz.com/features/analytics/" target="_blank">
|
|
<img
|
|
src="https://worklenz.s3.amazonaws.com/assets/screenshots/analytics-view.png"
|
|
alt="Worklenz analytics"
|
|
width="1024"
|
|
/>
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://worklenz.com/features/resource-management/" target="_blank">
|
|
<img
|
|
src="https://worklenz.s3.amazonaws.com/assets/screenshots/schedule-view.png"
|
|
alt="Worklenz scheduler"
|
|
width="1024"
|
|
/>
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://worklenz.com/features/templates/" target="_blank">
|
|
<img
|
|
src="https://worklenz.s3.amazonaws.com/assets/screenshots/templates-view.png"
|
|
alt="Worklenz templates"
|
|
width="1024"
|
|
/>
|
|
</a>
|
|
</p>
|
|
|
|
### Contributing
|
|
|
|
We welcome contributions from the community! If you'd like to contribute, please follow
|
|
our [contributing guidelines](CONTRIBUTING.md).
|
|
|
|
### Security
|
|
|
|
If you believe you have found a security vulnerability in Worklenz, we encourage you to responsibly disclose this and
|
|
not open a public issue. We will investigate all legitimate reports.
|
|
|
|
Email [info@worklenz.com](mailto:info@worklenz.com) to disclose any security vulnerabilities.
|
|
|
|
### License
|
|
|
|
Worklenz is open source and released under the [GNU Affero General Public License Version 3 (AGPLv3)](LICENSE).
|
|
|
|
By contributing to Worklenz, you agree that your contributions will be licensed under its AGPL.
|
|
|