Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kartikmanimuthu/playwright-starter-template
Playwright Starter Template repository! This template equips you to write end-to-end tests with Playwright, a versatile open-source testing library for modern web browsers. It incorporates Allure, an open-source framework for generating clear and comprehensive test reports, boosting your TDD approach.
https://github.com/kartikmanimuthu/playwright-starter-template
allure automation browser-testing e2e-testing playwright starter-template tdd test-automation test-reports testing
Last synced: 24 days ago
JSON representation
Playwright Starter Template repository! This template equips you to write end-to-end tests with Playwright, a versatile open-source testing library for modern web browsers. It incorporates Allure, an open-source framework for generating clear and comprehensive test reports, boosting your TDD approach.
- Host: GitHub
- URL: https://github.com/kartikmanimuthu/playwright-starter-template
- Owner: kartikmanimuthu
- Created: 2023-07-28T11:10:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-07-28T11:19:49.000Z (over 1 year ago)
- Last Synced: 2024-11-11T14:12:30.473Z (3 months ago)
- Topics: allure, automation, browser-testing, e2e-testing, playwright, starter-template, tdd, test-automation, test-reports, testing
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Playwright Starter Template
Welcome to the Playwright Starter Template repository! This project is a quick-start guide for anyone looking to write end-to-end tests using Playwright, an excellent open-source testing library capable of running tests in all modern web browsers.
This starter template goes a step further, integrating with Allure, an open-source framework designed to create test execution reports clear to everyone in the team. With this integration, you'll be able to easily generate beautiful and comprehensive test reports, enhancing your TDD approach.
## 🚀 Getting Started
### Prerequisites
- Node.js installed (version 12 or above)
- NPM for package management
- [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/downloads/#jdk17-mac)
- [Allure Commandline](https://docs.qameta.io/allure/)
### Installation
1. Clone this repository:
```
git clone https://github.com/Karthikmani345/playwright-starter-template.git
```
2. Navigate to the project directory:
```
cd playwright-starter-template
```
3. Install the dependencies:
```
npm install
```
4. Install Allure Commandline globally:
```
npm install -g allure-commandline
```
5. Now you're ready to write and execute tests!
## 📝 Writing Tests
Tests in Playwright are written in a straightforward manner. You can create a new file in the `tests` directory with the `.spec.js` suffix and start writing your tests. Playwright uses the BDD (Behavior Driven Development) testing structure, so your tests will typically include `describe` and `it` blocks.
## 🏃♂️ Running Tests
To run your tests, use the following command:
```
npm run test
```
For a UI driven approach to running your tests, use the following command:
```
npm run test:ui
```
## 📊 Generating Allure Reports
To generate Allure reports after your tests have run, use the following command:
```
npm run report:allure
```
This will generate a report and automatically open it in your browser.
## 🔎 Code Generation with Playwright
To use the code generation functionality in Playwright, use the following command:
```
npm run codegen
```
## 🧹 Clean Up
To clean up the generated test and report files, use the following command:
```
npm run clean
```
## 📖 Documentation
For more information about Playwright, please visit their [official documentation](https://playwright.dev/).
For more information about Allure, please visit their [official documentation](https://docs.qameta.io/allure/).
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/username/playwright-starter-template/issues).
## 📜 License
This project is [MIT](https://choosealicense.com/licenses/mit/) licensed.
---
Happy Testing! 💻
---