Skip to main content

Getting Started

Set up Ellithium in your project with these simple steps.

Prerequisites

  • Java Development Kit (JDK) 21
  • Maven 3.8.1+ (3.9.9 recommended)
  • Your favorite IDE (IntelliJ IDEA recommended)

Quick Start

1. Add Dependency

Add to your pom.xml:

<dependency>
<groupId>io.github.abdelrhman-ellithy</groupId>
<artifactId>ellithium</artifactId>
<version>2.0.4</version>
</dependency>

2. follow the instruction to installation and project setup

3. Initialize Project

Run in terminal:

mvn clean test

Next Steps

After installing Ellithium, you can start exploring its capabilities:

Utility Essentials

The Ellithium framework includes a rich set of utilities to speed up your test automation development:

// Generate test data
String name = TestDataGenerator.getRandomFullName();
String email = TestDataGenerator.getRandomEmail();

// Perform assertions with detailed reporting
AssertionExecutor.hard.assertTrue(user.isActive(), "User should be active");

// Work with various file formats
List<Map<String, String>> testData = JsonHelper.getJsonData("test-data.json");

Learn more about Utilities →