Task Management | Time Tracking | Analytics | Resource Management | Project Templates
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.
- 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.
This repository contains the frontend and backend code for Worklenz.
- Frontend: Built using React with Ant Design as the UI library.
- Backend: Built using TypeScript, Express.js, with PostgreSQL as the database.
- Node.js version v18 or newer
- PostgreSQL version v15 or newer
- Docker and Docker Compose (for containerized setup)
These instructions will help you set up and run the Worklenz project on your local machine for development and testing purposes.
- Node.js (version 18 or higher)
- PostgreSQL database
- An S3-compatible storage service (like MinIO) or Azure Blob Storage
- Clone the repository
git clone https://github.com/Worklenz/worklenz.git
cd worklenz-
Set up environment variables
- Copy the example environment files
cp .env.example .env cp worklenz-backend/.env.example worklenz-backend/.env
- Update the environment variables with your configuration
-
Install dependencies
# Install backend dependencies
cd worklenz-backend
npm install
# Install frontend dependencies
cd ../worklenz-frontend
npm install- Set up the database
# Create a PostgreSQL database named worklenz_db
cd worklenz-backend
# Execute the SQL setup files in the correct order
psql -U your_username -d worklenz_db -f database/sql/0_extensions.sql
psql -U your_username -d worklenz_db -f database/sql/1_tables.sql
psql -U your_username -d worklenz_db -f database/sql/indexes.sql
psql -U your_username -d worklenz_db -f database/sql/4_functions.sql
psql -U your_username -d worklenz_db -f database/sql/triggers.sql
psql -U your_username -d worklenz_db -f database/sql/3_views.sql
psql -U your_username -d worklenz_db -f database/sql/2_dml.sql
psql -U your_username -d worklenz_db -f database/sql/5_database_user.sql- Start the development servers
# In one terminal, start the backend
cd worklenz-backend
npm run dev
# In another terminal, start the frontend
cd worklenz-frontend
npm run dev- Access the application at http://localhost:5000
The project includes a fully configured Docker setup with:
- Frontend React application
- Backend server
- PostgreSQL database
- MinIO for S3-compatible storage
- Clone the repository:
git clone https://github.com/Worklenz/worklenz.git
cd worklenz- Start the Docker containers (choose one option):
Using Docker Compose directly
docker-compose up -d-
The application will be available at:
- Frontend: http://localhost:5000
- Backend API: http://localhost:3000
- MinIO Console: http://localhost:9001 (login with minioadmin/minioadmin)
-
To stop the services:
docker-compose downWorklenz requires several environment variables to be configured for proper operation. These include:
- Database credentials
- Session secrets
- Storage configuration (S3 or Azure)
- Authentication settings
Please refer to the .env.example files for a full list of required variables.
The project uses MinIO as an S3-compatible object storage service, which provides an open-source alternative to AWS S3 for development and production.
-
MinIO Console: http://localhost:9001
- Username: minioadmin
- Password: minioadmin
-
Default Bucket: worklenz-bucket (created automatically when the containers start)
For production deployments:
- Use strong, unique passwords and keys for all services
- Do not commit
.envfiles to version control - Use a production-grade PostgreSQL setup with proper backup procedures
- Enable HTTPS for all public endpoints
- Review and update dependencies regularly
We welcome contributions from the community! If you'd like to contribute, please follow our contributing guidelines.
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 to disclose any security vulnerabilities.
This project is licensed under the MIT License.
We welcome contributions from the community! If you'd like to contribute, please follow our contributing guidelines.
Worklenz is open source and released under the GNU Affero General Public License Version 3 (AGPLv3).
By contributing to Worklenz, you agree that your contributions will be licensed under its AGPL.
This repository contains the React version of Worklenz with a Docker setup for easy development and deployment.
The project includes a fully configured Docker setup with:
- Frontend React application
- Backend server
- PostgreSQL database
- MinIO for S3-compatible storage
- Docker and Docker Compose installed on your system
- Git
- Clone the repository:
git clone https://github.com/Worklenz/worklenz.git
cd worklenz- Start the Docker containers (choose one option):
Option 1: Using the provided scripts (easiest)
- On Windows:
start.bat - On Linux/macOS:
./start.sh
Option 2: Using Docker Compose directly
docker-compose up -d-
The application will be available at:
- Frontend: http://localhost:5000
- Backend API: http://localhost:3000
- MinIO Console: http://localhost:9001 (login with minioadmin/minioadmin)
-
To stop the services (choose one option):
Option 1: Using the provided scripts
- On Windows:
stop.bat - On Linux/macOS:
./stop.sh
Option 2: Using Docker Compose directly
docker-compose downThe project uses MinIO as an S3-compatible object storage service, which provides an open-source alternative to AWS S3 for development and production.
MinIO provides an S3-compatible API, so any code that works with S3 will work with MinIO by simply changing the endpoint URL. The backend has been configured to use MinIO by default, with no additional configuration required.
-
MinIO Console: http://localhost:9001
- Username: minioadmin
- Password: minioadmin
-
Default Bucket: worklenz-bucket (created automatically when the containers start)
The backend is pre-configured to use MinIO with the following settings:
// S3 credentials with MinIO defaults
export const REGION = process.env.AWS_REGION || "us-east-1";
export const BUCKET = process.env.AWS_BUCKET || "worklenz-bucket";
export const S3_URL = process.env.S3_URL || "http://minio:9000/worklenz-bucket";
export const S3_ACCESS_KEY_ID = process.env.AWS_ACCESS_KEY_ID || "minioadmin";
export const S3_SECRET_ACCESS_KEY = process.env.AWS_SECRET_ACCESS_KEY || "minioadmin";The S3 client is initialized with special MinIO configuration:
const s3Client = new S3Client({
region: REGION,
credentials: {
accessKeyId: S3_ACCESS_KEY_ID || "",
secretAccessKey: S3_SECRET_ACCESS_KEY || "",
},
endpoint: getEndpointFromUrl(), // Extracts endpoint from S3_URL
forcePathStyle: true, // Required for MinIO
});The project uses the following environment file structure:
-
Frontend:
worklenz-frontend/.env.development- Development environment variablesworklenz-frontend/.env.production- Production build variables
-
Backend:
worklenz-backend/.env- Backend environment variables
The Docker environment script will create or overwrite all environment files:
# For HTTP/WS
./update-docker-env.sh your-hostname
# For HTTPS/WSS
./update-docker-env.sh your-hostname trueThis script generates properly configured environment files for both development and production environments.
-
Set up the environment files:
# For HTTP/WS ./update-docker-env.sh # For HTTPS/WSS ./update-docker-env.sh localhost true
-
Run the application using Docker Compose:
docker-compose up -d
-
Access the application:
- Frontend: http://localhost:5000
- Backend API: http://localhost:3000 (or https://localhost:3000 with SSL)
When deploying to a remote server:
-
Set up the environment files with your server's hostname:
# For HTTP/WS ./update-docker-env.sh your-server-hostname # For HTTPS/WSS ./update-docker-env.sh your-server-hostname true
This ensures that the frontend correctly connects to the backend API.
-
Pull and run the latest Docker images:
docker-compose pull docker-compose up -d
-
Access the application through your server's hostname:
- Frontend: http://your-server-hostname:5000
- Backend API: http://your-server-hostname:3000
The Docker setup uses environment variables to configure the services:
-
Frontend:
VITE_API_URL: URL of the backend API (default: http://backend:3000 for container networking)VITE_SOCKET_URL: WebSocket URL for real-time communication (default: ws://backend:3000)
-
Backend:
- Database connection parameters
- Storage configuration
- Other backend settings
For custom configuration, edit the .env file or the update-docker-env.sh script.