simple-playwright-framework 0.0.14 → 0.0.15

package/README.md

@@ -0,0 +1,183 @@
+# simple-playwright-framework
+
+![npm version](https://img.shields.io/npm/v/simple-playwright-framework)
+![npm
+downloads](https://img.shields.io/npm/dm/simple-playwright-framework)
+![license](https://img.shields.io/npm/l/simple-playwright-framework)
+![node](https://img.shields.io/node/v/simple-playwright-framework)
+![playwright](https://img.shields.io/badge/Playwright-supported-45ba63?logo=playwright)
+![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)
+
+A lightweight and modular automation framework built on top of
+**Microsoft Playwright** to help teams quickly bootstrap scalable UI and
+API test automation projects.
+
+The framework focuses on simplicity, maintainability, and developer
+ergonomics while following modern test automation best practices.
+
+Repository: https://github.com/Udayakumarg/simpleplaywrightframework
+
+------------------------------------------------------------------------
+
+## Features
+
+-   Playwright-powered end‑to‑end browser automation
+-   Clean and scalable project structure
+-   Environment-aware configuration
+-   Reusable authentication sessions
+-   UI and API testing support
+-   File upload and download helpers
+-   CLI project scaffolding
+-   CI/CD ready architecture
+-   Easy integration with reporting tools such as Allure and TestRail
+
+------------------------------------------------------------------------
+
+## Installation
+
+### 1. Install Playwright
+
+``` bash
+npm install --save-dev @playwright/test playwright
+```
+
+### 2. Install the framework
+
+``` bash
+npm install simple-playwright-framework
+```
+
+------------------------------------------------------------------------
+
+## Create a Demo Project
+
+Use the CLI to generate a ready‑to‑run project:
+
+``` bash
+npx init-demo-project
+```
+
+This command scaffolds a demo project with the recommended structure.
+
+------------------------------------------------------------------------
+
+## Run Tests
+
+Navigate into the generated project and run:
+
+``` bash
+cd demo-project
+npx playwright test
+```
+
+Run tests with the Playwright UI runner:
+
+``` bash
+npx playwright test --ui
+```
+
+------------------------------------------------------------------------
+
+## Example Test
+
+``` ts
+import { test, expect } from '@playwright/test';
+
+test('homepage loads', async ({ page }) => {
+  await page.goto('https://example.com');
+  await expect(page).toHaveTitle(/Example/);
+});
+```
+
+------------------------------------------------------------------------
+
+## Project Structure
+
+Example project generated by the framework:
+
+    demo-project
+    │
+    ├── tests
+    │   └── example.spec.ts
+    │
+    ├── pages
+    │   └── login.page.ts
+    │
+    ├── utils
+    │   └── apiClient.ts
+    │
+    ├── config
+    │   └── environments.ts
+    │
+    ├── auth
+    │   └── storageState.json
+    │
+    └── playwright.config.ts
+
+------------------------------------------------------------------------
+
+## Environment Configuration
+
+Multiple environments can be configured easily.
+
+Example:
+
+``` ts
+export const environments = {
+  dev: {
+    baseUrl: "https://dev.example.com"
+  },
+  qa: {
+    baseUrl: "https://qa.example.com"
+  }
+};
+```
+
+This allows running tests across different deployment environments
+without changing test logic.
+
+------------------------------------------------------------------------
+
+## Reporting
+
+The framework works seamlessly with:
+
+-   Playwright HTML reports
+-   Allure reports
+-   TestRail integrations
+
+Generate the Playwright report:
+
+``` bash
+npx playwright show-report
+```
+
+------------------------------------------------------------------------
+
+## Contributing
+
+Contributions are welcome.
+
+If you would like to contribute:
+
+1.  Fork the repository
+2.  Create a feature branch
+3.  Commit your changes
+4.  Submit a pull request
+
+Please ensure that code changes include appropriate tests and follow
+existing coding conventions.
+
+------------------------------------------------------------------------
+
+## License
+
+MIT License
+
+------------------------------------------------------------------------
+
+## Author
+
+Developed by Udayakumar
+
+GitHub: https://github.com/Udayakumarg

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-playwright-framework",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "A modular Playwright framework with fixtures, loaders, and demo scaffolding.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",