https://github.com/serenity-js/serenity-js-playwright-ct-web-components-template
Test your Lit and native web components with Serenity/JS and Playwright Test
https://github.com/serenity-js/serenity-js-playwright-ct-web-components-template
component-testing lit playwright template web-components
Last synced: 4 months ago
JSON representation
Test your Lit and native web components with Serenity/JS and Playwright Test
- Host: GitHub
- URL: https://github.com/serenity-js/serenity-js-playwright-ct-web-components-template
- Owner: serenity-js
- License: apache-2.0
- Created: 2024-07-29T10:13:20.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-30T22:54:06.000Z (4 months ago)
- Last Synced: 2024-12-30T23:25:59.408Z (4 months ago)
- Topics: component-testing, lit, playwright, template, web-components
- Language: TypeScript
- Size: 42.9 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Serenity/JS Playwright Component Test Template
[](https://github.com/serenity-js/serenity-js-playwright-ct-web-components-template/actions/workflows/main.yml)
[](https://github.com/serenity-js/serenity-js)
[](https://stackoverflow.com/questions/tagged/serenity-js)
[](https://gitpod.io/from-referrer/)
[](https://www.linkedin.com/company/serenity-js)
[](https://www.youtube.com/@serenity-js)
[](https://matrix.to/#/#serenity-js:gitter.im)
[](https://github.com/sponsors/serenity-js)
Use this [template repository](https://help.github.com/en/articles/creating-a-repository-from-a-template)
to get started with testing your [Lit](https://lit.dev/) or native [Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components)
using [Serenity/JS](https://serenity-js.org), [Playwright](https://playwright.dev/), [Playwright Component Test](https://playwright.dev/docs/test-components)
and [Playwright CT Web](https://github.com/sand4rt/playwright-ct-web).
Learn more:
- [Serenity BDD reports for this project](https://serenity-js.github.io/serenity-js-playwright-ct-web-components-template/serenity/)
- [Playwright Test reports for this project](https://serenity-js.github.io/serenity-js-playwright-ct-web-components-template/playwright/)
- [Serenity/JS website, tutorials, and API docs](https://serenity-js.org/)
## Usage
This repository is a GitHub template. You can use it to [create a new GitHub repository](https://help.github.com/en/articles/creating-a-repository-from-a-template), [clone it to your computer](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
You can also launch it in a virtual Gitpod workspace without having to install anything on your machine:
[](https://gitpod.io/from-referrer/)
### Installation
To use this project on your machine, you'll need:
- Node.js, a Long-Term Support (LTS) release version 16 or later - [download](https://nodejs.org/en/)
- Java Runtime Environment (JRE) or a Java Development Kit (JDK) version 11 or later - [download](https://adoptopenjdk.net/)
Follow the [installation instructions](https://serenity-js.org/handbook/about/installation/) to help you verify your setup.
Once you have the code on your computer, use your computer terminal to run the following command in the directory where you've cloned the project:
```
npm ci
```
Running [`npm ci`](https://docs.npmjs.com/cli/v6/commands/npm-ci) downloads the [Node modules](https://docs.npmjs.com/about-packages-and-modules) this project depends on, as well as the [Serenity BDD CLI](https://github.com/serenity-bdd/serenity-cli) reporter jar.
### Corporate networks
If your network administrators require you to use proxy servers or an internal artifact registry (Artifactory, Nexus, etc.), your development environment might require some additional configuration.
The easiest way to do it is to create an [`.npmrc` file](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc) in your home directory:
```
proxy=http://user:[email protected]:8080/
https-proxy=http://user:[email protected]:8080/
strict-ssl=false
registry=https://artifactory.mycompany.com/artifactory/
```
If you encounter issues downloading the Serenity BDD CLI jar, please follow the [detailed instructions in the Serenity/JS Handbook](https://serenity-js.org/api/serenity-bdd/#downloading-the-serenity-bdd-reporting-cli).
### Execution
The project provides several [NPM scripts](https://docs.npmjs.com/cli/v6/using-npm/scripts) defined in [`package.json`](package.json):
```
npm run lint # runs code linter
npm run lint:fix # attempts to automatically fix linting issues
npm run clean # removes reports from any previous test run
npm test # executes the example test suite
# and generates the report under ./target/site/serenity
npm start # starts a mini HTTP server and serves the test reports
# at http://localhost:8080
```
## Your feedback matters!
Do you find Serenity/JS useful? Give it a ⭐ star on GitHub!
[](https://github.com/serenity-js/serenity-js)
Found a bug? Need a feature? Raise [an issue](https://github.com/serenity-js/serenity-js/issues?state=open)
or submit a pull request.
Have feedback? Let me know on [LinkedIn](https://www.linkedin.com/in/janmolak/) or leave a comment in [Serenity/JS discussions on GitHub](/serenity-js/serenity-js/discussions/categories/comments).
And if you have any questions about the framework, or simply want to say hello to other Serenity/JS developers, join us on [Serenity/JS Community Chat](https://matrix.to/#/#serenity-js:gitter.im).
## Support Serenity/JS
Serenity/JS is a free open-source framework, so we rely on our [wonderful GitHub sponsors](https://github.com/sponsors/serenity-js) to keep the lights on.
If you appreciate all the effort that goes into making sophisticated tools easy to work with, please support our work and [become a Serenity/JS GitHub Sponsor](https://github.com/sponsors/serenity-js) today!
[](https://www.linkedin.com/company/serenity-js)
[](https://www.youtube.com/@serenity-js)
[](https://github.com/sponsors/serenity-js)