Getting Started with Qulaxy

📋 Prerequisites

Before installing Qulaxy, ensure you have the following:

• Docker (version 20.10 or higher)
• Docker Compose (version 2.0 or higher)
• At least 4GB RAM available
• At least 10GB disk space
• An internet connection for pulling images

🚀 Quick Installation

Step 1: Pull the Core Images

Download the latest Qulaxy backend and frontend images from GitHub Container Registry:

Step 2: Start the Stack

Start Qulaxy with Docker Compose so the backend, frontend, database, cache, agents, and activity log service run together:

Step 3: Access Qulaxy

Open your browser and navigate to:

Official GHCR Images

Qulaxy is published as separate service images under the QulaxyQA GitHub Packages namespace:

ghcr.io/qulaxyqa/qulaxy-backend:latest
ghcr.io/qulaxyqa/qulaxy-frontend:latest
ghcr.io/qulaxyqa/qulaxy-activity-log:latest
ghcr.io/qulaxyqa/qulaxy-agent-node:latest
ghcr.io/qulaxyqa/qulaxy-agent-python:latest

🌐 Nginx Configuration

For a production domain, place Nginx in front of the frontend container and proxy API traffic to the backend:

server {
    listen 80;
    server_name qulaxy.yourcompany.com;

    location / {
        proxy_pass http://frontend:80;
        proxy_http_version 1.1;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    location /api/ {
        proxy_pass http://backend:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    location /socket.io/ {
        proxy_pass http://backend:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

Add Nginx to your Compose file when you want one public entry point for the site and API:

nginx:
  image: nginx:alpine
  restart: unless-stopped
  ports:
    - "80:80"
    - "443:443"
  volumes:
    - ./nginx.conf:/etc/nginx/conf.d/default.conf:ro
    - ./ssl:/etc/nginx/ssl:ro
  depends_on:
    - frontend
    - backend

🎯 First Steps

1. Create Your First Project

After logging in:

• Click "Create Project" in the dashboard
• Enter a project name and description
• Set up team members and permissions
• Configure project settings

2. Add Test Cases

Organize your testing efforts:

• Navigate to Test Cases tab
• Click "New Test Case"
• Fill in test steps, expected results, and priority
• Add tags and custom fields as needed

3. Execute Tests

Start running your test suites:

• Create a Test Run from your test cases
• Assign test cases to team members
• Track execution progress in real-time
• Record results and attach screenshots

📊 Understanding the Dashboard

The Qulaxy dashboard provides:

• Test Execution Overview - Pass/fail rates and trends
• Active Test Runs - Current testing activities
• Team Activity - Who's working on what
• Defect Tracking - Open issues and bugs
• Reports - Downloadable metrics and charts

🔗 Next Steps

Now that you're set up, explore these topics:

• Configuration - Customize Qulaxy for your team
• Deployment Guide - Set up for production
• Customization - Create custom workflows