https://github.com/charlyautomatiza/starter-playwright

Boilerplate project for Web/API Test Automation created live on Twitch based on Playwright - TypeScript - Allure Report - Lighthouse
https://github.com/charlyautomatiza/starter-playwright

a11y a11y-testing accessibility allure-report boilerplate lighthouse playwright qa qaautomation testautomationframework testing typescript webtesting

Last synced: 5 days ago
JSON representation

Boilerplate project for Web/API Test Automation created live on Twitch based on Playwright - TypeScript - Allure Report - Lighthouse

• Host: GitHub
• URL: https://github.com/charlyautomatiza/starter-playwright
• Owner: charlyautomatiza
• Created: 2022-01-20T23:17:25.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T23:27:00.000Z (3 months ago)
• Last Synced: 2024-10-22T17:32:29.223Z (14 days ago)
• Topics: a11y, a11y-testing, accessibility, allure-report, boilerplate, lighthouse, playwright, qa, qaautomation, testautomationframework, testing, typescript, webtesting
• Language: TypeScript
• Homepage: https://charlyautomatiza.tech
• Size: 8.84 MB
• Stars: 83
• Watchers: 2
• Forks: 15
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  

  

  

  





🎭 Playwright


# Web Test Automation - Playwright

## Boilerplate project created live on [Twitch.tv/CharlyAutomatiza](https://www.twitch.tv/charlyautomatiza) based on [Playwright](https://playwright.dev/), [TypeScript](https://www.typescriptlang.org/), [Allure Report](https://docs.qameta.io/allure-report/)

You can access my [YouTube](https://www.youtube.com/c/CharlyAutomatiza?sub_confirmation=1) channel for more information about this and other automated testing frameworks.

[![Playwright Tests](https://github.com/charlyautomatiza/starter-playwright/actions/workflows/playwright.yml/badge.svg)](https://github.com/charlyautomatiza/starter-playwright/actions/workflows/playwright.yml)

### Overview

Esta documentación está disponible también en [**Castellano**](LEEME.md).

### General requirements

- Install a git client such as [git bash](https://git-scm.com/downloads)

Download and install

- Latest version of [Node.js](https://nodejs.org/es/download/)

- Java Development Kit [(JDK)](https://www.oracle.com/java/technologies/downloads/)

  - Make sure you have the environment variable **JAVA_HOME** set to the path of the respective JDK. **(Required for Allure report generation)**.

### Installation of the testing framework

#### **Clone the repository:**

    git clone https://github.com/charlyautomatiza/starter-playwright.git

#### **Install dependencies.**

    npm install

#### **To run the tests go to the root of the project and run (headless mode)**

    npm run test

#### **To run the tests go to the root of the project and run (headed mode)**

    npm run test-head

#### **To run the tests only on Firefox**

    npm run firefox

#### **To run the tests only on Chromium**

    npm run chromium

#### **To run the tests only on Webkit**

    npm run webkit

#### **To run the tests with UI + API Examples**

    npm run api-ui

#### **To run the tests with UI + API + Mockaroo Examples**

    npm run data-mgmt

**IMPORTANT**:

To run your own [Mockaroo](https://www.mockaroo.com/) examples you should create a free account, create a new schema and create a new .env file with your **API_KEY**

Example .env:

    API_KEY=000zz999

#### **For running Accessibility Testing examples with [Lighthouse](https://www.npmjs.com/package/playwright-lighthouse)**

    npm run a11y

**IMPORTANT**:

In the `thresholds` section of the [a11y.lighthouse.spec.ts](./tests/a11y.lighthouse.spec.ts) file, you can configure the acceptance level of the `accessibility`, `performance`, `SEO`, `best-practices`, `pwa` respectively.

If our threshold is 100 for `accessibility`, our test must have 100% acceptance to be considered successful.

```typescript

thresholds: {

    performance: 50,

    accessibility: 100,

    'best-practices': 50,

    seo: 50,

    pwa: 0,

},

```

#### **To open Playwright's unified Html report of test results**

    npm run play-report

#### **To create and open the Allure unified report of test results**

    npm run open-report

#### **IMPORTANT**

After each upgrade of **Playwright**, the project must be restarted locally with the command:

    npm run reinstall

To download the latest versions of the Browsers.