You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/serenity-js/serenity-js)
5
-
[](https://stackoverflow.com/questions/tagged/serenity-js)
6
-
[](https://gitpod.io/from-referrer/)
7
4
8
-
[](https://www.linkedin.com/company/serenity-js)
9
-
[](https://www.youtube.com/@serenity-js)
10
-
[](https://matrix.to/#/#serenity-js:gitter.im)
11
-
[](https://github.com/sponsors/serenity-js)
12
-
13
-
Use this [template repository](https://help.github.com/en/articles/creating-a-repository-from-a-template)
14
-
to get started with acceptance testing your web applications using [Serenity/JS](https://serenity-js.org),
15
-
[Playwright](https://playwright.dev/) and [Playwright Test](https://playwright.dev/docs/intro).
16
-
17
-
Learn more:
18
-
-[Serenity BDD reports for this project](https://serenity-js.github.io/serenity-js-playwright-test-template/serenity/)
19
-
-[Playwright Test reports for this project](https://serenity-js.github.io/serenity-js-playwright-test-template/playwright/)
20
-
-[Serenity/JS website, tutorials, and API docs](https://serenity-js.org/)
21
-
-[API Testing with Serenity/JS](https://serenity-js.org/handbook/api-testing/)
5
+
This [template](https://help.github.com/en/articles/creating-a-repository-from-a-template) helps you test
6
+
web applications and REST/HTTP APIs using [Serenity/JS](https://serenity-js.org) and the [Playwright Test](https://playwright.dev/) runner,
7
+
with a fully configured TypeScript setup.
22
8
23
-
## Usage
9
+
## Features
24
10
25
-
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).
11
+
- Preconfigured Serenity/JS + Playwright Test + TypeScript setup
12
+
- Example web and REST API test scenarios
13
+
- Linting and CI-friendly scripts
14
+
- Ready-to-use GitHub Codespaces environment using the official [Serenity/JS Docker image](https://serenity-js.org/handbook/integration/docker/) for quick exploration
15
+
- Integrated reporting via Serenity BDD and Playwright, with live examples:
-[Playwright Test report](https://serenity-js.github.io/serenity-js-playwright-test-template/playwright/)
26
18
27
-
You can also launch it in a virtual Gitpod workspace without having to install anything on your machine:
19
+
## Quick Start
28
20
29
-
[](https://gitpod.io/from-referrer/)
21
+
### Explore instantly in GitHub Codespaces
30
22
31
-
### Installation
23
+
Launch this project in an online development environment:
32
24
33
-
To use this project on your machine, you'll need:
34
-
- Node.js, a Long-Term Support (LTS) release version 16 or later - [download](https://nodejs.org/en/)
35
-
- Java Runtime Environment (JRE) or a Java Development Kit (JDK) version 11 or later - [download](https://adoptopenjdk.net/)
25
+
[](https://github.com/codespaces/new?ref=main&repo=serenity-js/serenity-js-playwright-test-template)
36
26
37
-
Follow the [installation instructions](https://serenity-js.org/handbook/getting-started/installation/) to help you verify your setup.
27
+
### Run locally
38
28
39
-
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:
29
+
- Follow the [Serenity/JS installation guide](https://serenity-js.org/handbook/about/installation/)
30
+
-[Create a new repository](https://help.github.com/en/articles/creating-a-repository-from-a-template) from this template
31
+
-[Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) it to your machine
32
+
- Install dependencies:
40
33
```
41
34
npm ci
42
35
```
43
-
44
-
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.
Then open [http://localhost:8080](http://localhost:8080) in your browser.
45
48
46
49
### Corporate networks
47
50
48
-
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.
49
-
50
-
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:
51
+
If your environment requires proxy configuration or an internal registry like Artifactory or Nexus, add an [`.npmrc` file](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc) file
52
+
with the appropriate configuration to your home directory:
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).
60
-
61
-
### Execution
61
+
## Execution
62
62
63
63
The project provides several [NPM scripts](https://docs.npmjs.com/cli/v6/using-npm/scripts) defined in [`package.json`](package.json):
64
64
@@ -72,25 +72,59 @@ npm start # starts a mini HTTP server and serves the test reports
72
72
# at http://localhost:8080
73
73
```
74
74
75
-
## Your feedback matters!
75
+
## Next steps
76
76
77
-
Do you find Serenity/JS useful? Give it a ⭐ star on GitHub!
77
+
- Replace the sample components with your own UI elements
78
+
- Add new tasks, interactions, and assertions using Serenity/JS
79
+
- Extend the test suite or integrate it into CI/CD pipelines
80
+
- Use the sample reports to understand expected testing and reporting workflows
-[More examples and reference implementations](https://github.com/serenity-js/serenity-js/tree/main/examples)
88
+
-[Tutorial: First Web Scenario](https://serenity-js.org/handbook/tutorials/your-first-web-scenario/)
89
+
-[Tutorial: First API Scenario](https://serenity-js.org/handbook/tutorials/your-first-api-scenario/)
83
90
84
-
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).
91
+
## Contributing
85
92
86
-
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).
93
+
Contributions of all kinds are welcome! Get started with the [Contributing Guide](https://serenity-js.org/community/contributing/).
87
94
88
-
## Support Serenity/JS
95
+
## Community
89
96
90
-
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.
97
+
[](https://www.linkedin.com/company/serenity-js)
98
+
[](https://www.youtube.com/@serenity-js)
99
+
[](https://matrix.to/#/#serenity-js:gitter.im)
91
100
92
-
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!
101
+
Connect with other developers using Serenity/JS:
102
+
103
+
-[Updates on LinkedIn](https://www.linkedin.com/company/serenity-js)
The Serenity/JS code base is licensed under the [Apache-2.0](https://opensource.org/license/apache-2-0) license,
117
+
while its documentation and the [Serenity/JS Handbook](https://serenity-js.org/handbook/) are licensed under the [Creative Commons BY-NC-SA 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/).
118
+
119
+
See the [Serenity/JS License](https://serenity-js.org/legal/license/).
120
+
121
+
## Support
122
+
123
+
Support ongoing development through [GitHub Sponsors](https://github.com/sponsors/serenity-js). Sponsors gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks)
124
+
and priority help in the [Discussions Forum](https://github.com/orgs/serenity-js/discussions).
125
+
126
+
For commercial support or corporate sponsorship, please contact [Jan Molak](https://www.linkedin.com/in/janmolak/).
0 commit comments