{"id":17545937,"url":"https://github.com/charlyautomatiza/starter-playwright","last_synced_at":"2025-04-06T06:13:10.663Z","repository":{"id":37955415,"uuid":"450288200","full_name":"charlyautomatiza/starter-playwright","owner":"charlyautomatiza","description":"Boilerplate project for Web/API Test Automation created live on Twitch based on Playwright - TypeScript - Allure Report - Lighthouse","archived":false,"fork":false,"pushed_at":"2025-03-04T22:06:38.000Z","size":9401,"stargazers_count":99,"open_issues_count":8,"forks_count":17,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T05:08:10.224Z","etag":null,"topics":["a11y","a11y-testing","accessibility","allure-report","boilerplate","lighthouse","playwright","qa","qaautomation","testautomationframework","testing","typescript","webtesting"],"latest_commit_sha":null,"homepage":"https://charlyautomatiza.tech","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/charlyautomatiza.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-20T23:17:25.000Z","updated_at":"2025-03-11T17:46:40.000Z","dependencies_parsed_at":"2024-05-15T16:11:13.772Z","dependency_job_id":"accc0fc4-ae14-4c07-ba72-68b1b9902fd8","html_url":"https://github.com/charlyautomatiza/starter-playwright","commit_stats":{"total_commits":34,"total_committers":3,"mean_commits":"11.333333333333334","dds":"0.11764705882352944","last_synced_commit":"881b40801634da920f54816dc0dd4f5e870ebcbf"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlyautomatiza%2Fstarter-playwright","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlyautomatiza%2Fstarter-playwright/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlyautomatiza%2Fstarter-playwright/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlyautomatiza%2Fstarter-playwright/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/charlyautomatiza","download_url":"https://codeload.github.com/charlyautomatiza/starter-playwright/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247441059,"owners_count":20939239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a11y","a11y-testing","accessibility","allure-report","boilerplate","lighthouse","playwright","qa","qaautomation","testautomationframework","testing","typescript","webtesting"],"created_at":"2024-10-21T01:25:27.464Z","updated_at":"2025-04-06T06:13:10.637Z","avatar_url":"https://github.com/charlyautomatiza.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.twitch.tv/charlyautomatiza\"\u003e\u003cimg alt=\"Twitch\" src=\"https://img.shields.io/badge/CharlyAutomatiza-Twitch-9146FF.svg\" style=\"max-height: 300px;\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://discord.gg/wwM9GwxmRZ\"\u003e\u003cimg alt=\"Discord\" src=\"https://img.shields.io/discord/944608800361570315\" style=\"max-height: 300px;\"\u003e\u003c/a\u003e\n  \u003ca href=\"http://twitter.com/char_automatiza\"\u003e\u003cimg src=\"https://img.shields.io/badge/@char__automatiza-Twitter-1DA1F2.svg?style=flat\" style=\"max-height: 300px;\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.youtube.com/c/CharlyAutomatiza?sub_confirmation=1\"\u003e\u003cimg src=\"https://img.shields.io/badge/CharlyAutomatiza-Youtube-FF0000.svg\" style=\"max-height: 300px;\" style=\"max-height: 300px;\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.linkedin.com/in/gautocarlos/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Carlos%20 Gauto-LinkedIn-0077B5.svg\" style=\"max-height: 300px;\" style=\"max-height: 300px;\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch1 dir=\"auto\"\u003e\u003ca class=\"anchor\" aria-hidden=\"true\" href=\"https://playwright.dev/\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath fill-rule=\"evenodd\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003cg-emoji class=\"g-emoji\" alias=\"performing_arts\" fallback-src=\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png\"\u003e🎭\u003c/g-emoji\u003e Playwright\u003c/h1\u003e\n\n# Web Test Automation - Playwright\n\n## 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/)\n\nYou can access my [YouTube](https://www.youtube.com/c/CharlyAutomatiza?sub_confirmation=1) channel for more information about this and other automated testing frameworks.\n\n[![Playwright Tests](https://github.com/charlyautomatiza/starter-playwright/actions/workflows/playwright.yml/badge.svg)](https://github.com/charlyautomatiza/starter-playwright/actions/workflows/playwright.yml)\n\n### Overview\n\nEsta documentación está disponible también en [**Castellano**](LEEME.md).\n\n### General requirements\n\n- Install a git client such as [git bash](https://git-scm.com/downloads)\n\nDownload and install\n\n- Latest version of [Node.js](https://nodejs.org/es/download/)\n- Java Development Kit [(JDK)](https://www.oracle.com/java/technologies/downloads/)\n  - Make sure you have the environment variable **JAVA_HOME** set to the path of the respective JDK. **(Required for Allure report generation)**.\n\n### Installation of the testing framework\n\n#### **Clone the repository:**\n\n    git clone https://github.com/charlyautomatiza/starter-playwright.git\n\n#### **Install dependencies.**\n\n    npm install\n\n#### **To run the tests go to the root of the project and run (headless mode)**\n\n    npm run test\n\n#### **To run the tests go to the root of the project and run (headed mode)**\n\n    npm run test-head\n\n#### **To run the tests only on Firefox**\n\n    npm run firefox\n\n#### **To run the tests only on Chromium**\n\n    npm run chromium\n\n#### **To run the tests only on Webkit**\n\n    npm run webkit\n\n#### **To run the tests with UI + API Examples**\n\n    npm run api-ui\n\n#### **To run the tests with UI + API + Mockaroo Examples**\n\n    npm run data-mgmt\n\n**IMPORTANT**:\n\nTo 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**\n\nExample .env:\n\n    API_KEY=000zz999\n\n#### **For running Accessibility Testing examples with [Lighthouse](https://www.npmjs.com/package/playwright-lighthouse)**\n\n    npm run a11y\n\n**IMPORTANT**:\n\nIn 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.\n\nIf our threshold is 100 for `accessibility`, our test must have 100% acceptance to be considered successful.\n\n```typescript\nthresholds: {\n    performance: 50,\n    accessibility: 100,\n    'best-practices': 50,\n    seo: 50,\n    pwa: 0,\n},\n```\n\n#### **To open Playwright's unified Html report of test results**\n\n    npm run play-report\n\n#### **To create and open the Allure unified report of test results**\n\n    npm run open-report\n\n#### **IMPORTANT**\n\nAfter each upgrade of **Playwright**, the project must be restarted locally with the command:\n\n    npm run reinstall\n\nTo download the latest versions of the Browsers.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlyautomatiza%2Fstarter-playwright","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharlyautomatiza%2Fstarter-playwright","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlyautomatiza%2Fstarter-playwright/lists"}