Skip to content

Commit 575d01e

Browse files
committed
docs(readme): updated the readme
1 parent 4c9b161 commit 575d01e

File tree

1 file changed

+56
-38
lines changed

1 file changed

+56
-38
lines changed

README.md

Lines changed: 56 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,89 @@
11
# Serenity/JS Mocha WebdriverIO Template
22

3-
[![Build Status](https://github.com/serenity-js/serenity-js-mocha-webdriverio-template/workflows/build/badge.svg)](https://github.com/serenity-js/serenity-js-mocha-webdriverio-template/actions)
4-
[![Serenity/JS on GitHub](https://img.shields.io/badge/github-serenity--js-yellow?logo=github)](https://github.com/serenity-js/serenity-js)
5-
[![Serenity/JS on StackOverflow](https://img.shields.io/badge/stackoverflow-serenity--js-important?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/serenity-js)
6-
[![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/from-referrer/)
7-
83
[![Follow Serenity/JS on LinkedIn](https://img.shields.io/badge/Follow-Serenity%2FJS%20-0077B5?logo=linkedin)](https://www.linkedin.com/company/serenity-js)
94
[![Watch Serenity/JS on YouTube](https://img.shields.io/badge/Watch-@serenity--js-E62117?logo=youtube)](https://www.youtube.com/@serenity-js)
105
[![Join Serenity/JS Community Chat](https://img.shields.io/badge/Chat-Serenity%2FJS%20Community-FBD30B?logo=matrix)](https://matrix.to/#/#serenity-js:gitter.im)
6+
[![GitHub stars](https://img.shields.io/github/stars/serenity-js/serenity-js?label=Serenity%2FJS&logo=github&style=badge)](https://github.com/serenity-js/serenity-js)
117
[![Support Serenity/JS on GitHub](https://img.shields.io/badge/Support-@serenity--js-703EC8?logo=github)](https://github.com/sponsors/serenity-js)
128

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-
[Mocha](https://mochajs.org/) and [WebdriverIO](https://webdriver.io/).
9+
[![Build Status](https://github.com/serenity-js/serenity-js-mocha-webdriverio-template/workflows/build/badge.svg)](https://github.com/serenity-js/serenity-js-mocha-webdriverio-template/actions)
10+
[![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/from-referrer/)
11+
12+
13+
Kickstart your web application acceptance testing with [Serenity/JS](https://serenity-js.org), [Mocha](https://mochajs.org/),
14+
and [WebdriverIO](https://webdriver.io/) using this template repository.
1615

17-
Learn more:
18-
- [Serenity BDD reports for this project](https://serenity-js.github.io/serenity-js-mocha-webdriverio-template/)
19-
- [Serenity/JS website, tutorials, and API docs](https://serenity-js.org/)
16+
Learn more about Serenity/JS:
17+
[Serenity/JS and WebdriverIO guide](https://serenity-js.org/handbook/test-runners/webdriverio/)
2018

21-
## Usage
19+
## 🚀 Quick Start
2220

23-
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).
21+
### 1. Create a Project
2422

25-
You can also launch it in a virtual Gitpod workspace without having to install anything on your machine:
23+
This repository is a GitHub template. Use it to [create a new GitHub repository](https://help.github.com/en/articles/creating-a-repository-from-a-template)
24+
for your project.
25+
26+
If you prefer to work in a virtual environment, you can launch this repository in a [Gitpod](https://gitpod.io/from-referrer/) workspace.
2627

2728
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
2829

29-
### Installation
30+
### 2. Set Up Your Environment
31+
32+
Install the required tools:
33+
34+
- [Node.js](https://nodejs.org/en/) (LTS version 18.12 or later)
3035

31-
To use this project, you'll need:
32-
- Node.js, a Long-Term Support (LTS) release version 18.12 or later - [download](https://nodejs.org/en/)
33-
- Java Runtime Environment (JRE) or a Java Development Kit (JDK) version 11 or later - [download](https://adoptopenjdk.net/)
36+
- [Java](https://adoptopenjdk.net/) (JRE or JDK version 11 or later)
3437

35-
Follow the [installation instructions](https://serenity-js.org/handbook/about/installation/) to help you verify your setup.
38+
Follow the [installation guide](https://serenity-js.org/handbook/getting-started/installation/) to verify your setup.
39+
40+
### 3. Install Dependencies
41+
42+
[Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the project and run:
3643

37-
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:
3844
```
3945
npm ci
4046
```
4147

42-
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 latest version of [`chromedriver`](https://www.npmjs.com/package/chromedriver) and the [Serenity BDD CLI](https://github.com/serenity-bdd/serenity-cli) reporter jar.
43-
44-
### Corporate networks
48+
This installs dependencies, including the [Serenity BDD CLI](https://serenity-js.org/handbook/reporting/serenity-bdd-reporter/).
4549

46-
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.
50+
### 4. Run Tests
4751

48-
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:
52+
Use the predefined [NPM scripts](https://docs.npmjs.com/cli/v10/using-npm/scripts) defined in [`package.json`](package.json) to run your tests
53+
and related tasks:
4954

5055
```
51-
proxy=http://user:[email protected]:8080/
52-
https-proxy=http://user:[email protected]:8080/
53-
strict-ssl=false
54-
registry=https://artifactory.mycompany.com/artifactory/
56+
npm test # Run tests and generate reports
57+
npm start # Serve test reports at http://localhost:8080
58+
59+
npm run lint # Run code linter
60+
npm run lint:fix # Try to automatically fix linting issues
61+
npm run clean # Remove test reports from any previous test run
5562
```
5663

57-
### Execution
64+
### 5. Write your tests
65+
66+
Test scenarios are located in the [`./test/specs`](/test/specs) directory.
67+
Modify the examples or write your own scenarios using the [Serenity/JS Screenplay Pattern](https://serenity-js.org/handbook/design/screenplay-pattern/).
68+
69+
## 🌟 Features
5870

59-
The project provides several [NPM scripts](https://docs.npmjs.com/cli/v6/using-npm/scripts) defined in [`package.json`](package.json):
71+
- **All automation tools ready to go**: Start testing immediately with WebdriverIO, Serenity/JS and Mocha already integrated and configured.
72+
- **Serenity BDD Reports**: Serenity BDD reporter pre-configured with reports available at `./target/site/serenity`
73+
- **Published Reports**: Reports for this repository are published to GitHub Pages and available at https://serenity-js.github.io/serenity-js-mocha-webdriverio-template/.
74+
- **Screenplay Pattern**: Out-of-the-box integration with the Serenity/JS actors and Screenplay Pattern APIs
75+
- **GitHub Actions**: Continuous Integration setup included
76+
- **VS Code**: Pre-configured for a seamless developer experience
77+
78+
### 🔧 Configuration for Corporate Networks
79+
80+
If you're behind a proxy or use an internal registry, configure an [`.npmrc` file](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc) in your home directory:
6081

6182
```
62-
npm run lint # runs code linter
63-
npm run lint:fix # attempts to automatically fix linting issues
64-
npm run clean # removes reports from any previous test run
65-
npm test # executes the example test suite
66-
# and generates the report under ./target/site/serenity
67-
npm start # starts a mini HTTP server and serves the test reports
68-
# at http://localhost:8080
83+
proxy=http://user:[email protected]:8080/
84+
https-proxy=http://user:[email protected]:8080/
85+
strict-ssl=false
86+
registry=https://artifactory.mycompany.com/artifactory/
6987
```
7088

7189
## 💡️ Learn Serenity/JS

0 commit comments

Comments
 (0)