Create README.md

Include setup, usage, and test instructions in README

Author: OmarElsheikh1

README.md

@@ -0,0 +1,236 @@
+# ✅ Todo Application Test Automation Framework
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/OmarElsheikh1/selenium-todo-testing-framework/main.yml?label=Build&logo=githubactions)]([https://github.com/OmarElsheikh1/selenium-todo-testing-framework/actions](https://github.com/OmarElsheikh1/todo-app-qa-task/actions))
+
+
+[![Java](https://img.shields.io/badge/Java-21-blue?logo=java)](https://docs.oracle.com/en/java/javase/21/)
+[![Selenium](https://img.shields.io/badge/Selenium-4.x-green?logo=selenium)](https://www.selenium.dev/documentation/)
+[![RestAssured](https://img.shields.io/badge/REST--Assured-4.5.1-lightgrey?logo=restassured)](https://rest-assured.io/)
+[![TestNG](https://img.shields.io/badge/TestNG-7.8-red?logo=testng)](https://testng.org/)
+[![Maven](https://img.shields.io/badge/Maven-3.8+-brightgreen?logo=apachemaven)](https://maven.apache.org/)
+[![Allure](https://img.shields.io/badge/Allure-2.20.1-magenta?logo=allure)](https://docs.qameta.io/allure/)
+
+A comprehensive automation framework for testing a Todo application, covering both UI workflows and API endpoints with robust test cases and reporting capabilities.
+
+---
+
+## 🚀 Features
+Hybrid Testing: UI tests with Selenium WebDriver + API tests with RestAssured
+
+Multi‑Environment: Easily switch between local, staging, and production via properties
+
+Page Object Model: Separation of page logic from test logic for maintainability
+
+Allure Reporting: Interactive test reports and failure screenshots
+
+Parallel Execution: Thread‑safe WebDriver via ThreadLocal
+
+Data‑Driven: Dynamic test data generation with JavaFaker
+
+## 📁 Framework Structure
+```root/
+├── src/
+│   ├── main/
+│   │   └── java/com/omarelsheikh/todo/
+│   │       ├── api/
+│   │       │   ├── config/             # API endpoints
+│   │       │   └── models/             # API POJOs
+│   │       ├── drivers/                # WebDriver factory
+│   │       ├── models/                 # Domain models (Todo, User)
+│   │       ├── pages/                  # Page Object classes
+│   │       └── utils/                  # Config + properties management
+│   └── test/
+│       └── java/com/omarelsheikh/todo/
+│           ├── api/
+│           │   ├── requests/           # API call wrappers
+│           │   ├── testcases/          # API test cases
+│           │   └── utils/              # API helper utilities
+│           ├── base/                   # Shared BaseTest class
+│           ├── ui/
+│           │   └── testcases/          # UI test cases
+│           └── utils/                  # Test data utilities
+├── resources/
+│   └── config/
+│       ├── local.properties
+│       └── production.properties
+```
+
+---
+
+## 🛠 Technologies Used
+
+- **Languages**: Java 17+
+- **Testing Frameworks**: TestNG, RestAssured
+- **Web Automation**: Selenium WebDriver 4.0+
+- **Reporting**: Allure Framework
+- **Dependency Management**: Maven
+- **Test Data**: JavaFaker
+
+---
+
+## Test Coverage
+
+### API Tests
+- ✅ Authentication (Login/Logout)
+- ✅ Todo CRUD operations
+- ✅ Error handling (400/401/404 responses)
+- ✅ Data validation
+- ✅ Authorization checks
+
+### UI Tests
+- ✅ User registration and login
+- ✅ Todo management (add/complete/delete)
+- ✅ Form validation
+- ✅ Session management
+- ✅ Error message verification
+
+---
+
+## ▶️ Getting Started
+
+### ✅ Prerequisites
+- Java 17 JDK
+
+- Maven 3.8+
+
+- Chrome, Firefox or Edge installed
+
+### 🛠️ Installation
+
+1. Clone the repository
+```bash
+git clone https://github.com/your-username/todo-test-automation.git
+```
+
+2. Navigate to the project directory
+```bash
+cd todo-test-automation
+```
+
+3. Install dependencies
+```bash
+mvn clean install
+```
+
+4. Configure environments
+Edit the file based on the target environment:
+```route
+src/test/resources/config/local.properties or production.properties
+```
+
+Example:
+```properties
+baseUrl = https://todo.qacart.com
+email = omar-production@qatask.com
+password = Test1234
+```
+
+### ▶️ Run Your Tests
+By default, tests run on Chrome using the production environment:
+
+```bash
+mvn clean test
+```
+
+You can also customize:
+
+Change browser:
+
+```bash
+mvn clean test -Dbrowser=firefox
+mvn clean test -Dbrowser=edge
+```
+
+Change environment:
+```bash
+mvn clean test -Denv=local
+```
+
+Use both:
+```bash
+mvn clean test -Dbrowser=firefox -Denv=production
+```
+
+### 📊 View the Allure Report
+After running the tests:
+
+```bash
+allure serve allure-results
+```
+This will open an interactive test report in your browser.
+
+---
+
+## 💡 Key Snippets
+
+### Hybrid Flow: API → UI
+```java
+Copy
+Edit
+// Register via API
+RegisterApi registerApi = new RegisterApi();
+registerApi.register();
+
+// Inject cookies into the browser session
+injectCookiesToBrowser(registerApi.getCookies());
+
+// Continue with UI tests
+TodoPage todoPage = new TodoPage(driver);
+todoPage.load();
+```
+
+### Environment Configuration
+```java
+String env = System.getProperty("env", "PRODUCTION").toUpperCase();
+switch (env) {
+    case "PRODUCTION":
+        properties = load("production.properties");
+        break;
+    case "LOCAL":
+        properties = load("local.properties");
+        break;
+    default:
+        throw new RuntimeException("Environment not supported");
+}
+```
+
+---
+
+## 🚦 Best Practices Implemented
+Separation of Concerns: API, UI, and test layers cleanly divided
+
+Singleton Config: Centralized environment config loading
+
+Thread Safety: ThreadLocal<WebDriver> for parallel runs
+
+Fluent Interfaces: Chainable page object methods
+
+Robust Reporting: Allure annotations, steps, and screenshots
+
+Data Generation: Randomized test data with JavaFaker
+
+---
+
+## 🤝 Contributing
+1. Fork the repository
+
+2. Create a feature branch:
+```bash
+git checkout -b feature/your-feature
+```
+
+3. Commit your changes:
+
+```bash
+git commit -m "Add: brief description"
+```
+
+4. Push and open a Pull Request
+
+---
+
+## 🤝 Contact
+
+If you have any questions, suggestions, or want to collaborate, feel free to reach out.
+
+📧 omar1999.elsheikh@gmail.com  
+🔗 [LinkedIn](https://www.linkedin.com/in/omar-elsheikh1999/)