@maxio-com/self-service 1.2.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.typescriptlang.org) [](https://github.com/prettier/prettier) [](https://facebook.github.io/jest/) [](http://commitizen.github.io/cz-cli/) [](https://yarnpkg.com/en/) [](https://lerna.js.org/)
|
|
4
4
|
|
|
5
|
-
## Installation
|
|
5
|
+
## 🔧 Installation
|
|
6
6
|
|
|
7
7
|
Please follow the steps described below to correctly setup mono-repository.
|
|
8
8
|
|
|
9
9
|
#### Required system dependencies
|
|
10
10
|
|
|
11
11
|
- [NodeJS](https://nodejs.org/en/) - JavaScript runtime environment.
|
|
12
|
-
- [
|
|
12
|
+
- [pnpm](https://pnpm.io/) - package manager used to maintain project dependencies
|
|
13
13
|
|
|
14
14
|
### a. NodeJS
|
|
15
15
|
|
|
@@ -53,7 +53,7 @@ Run command defined below in the command-line interface:
|
|
|
53
53
|
| ------------------- | ----------------------------------------- |
|
|
54
54
|
| `docker-compose up` | runs mock server instance on port `8080`. |
|
|
55
55
|
|
|
56
|
-
## npm scripts
|
|
56
|
+
## ✨ npm scripts
|
|
57
57
|
|
|
58
58
|
List of useful commands that could be used by developers. Execution in the command-line interface should be prefixed with `yarn` package manager.
|
|
59
59
|
|
|
@@ -87,5 +87,26 @@ This repository builds multiple artifacts to address different integration use c
|
|
|
87
87
|
| `Types Definitions` | types declarations for applications implemented in `TypeScript` environment. |
|
|
88
88
|
|
|
89
89
|
### translations
|
|
90
|
-
Some translations are allowed to have basic HTML tags inside like `<strong>` or `<i>`.
|
|
91
|
-
However, this only works for elements without additional attributes (like className), having none or a single text children and provided that we use them in places that allow by design for text formatting.
|
|
90
|
+
Some translations are allowed to have basic HTML tags inside like `<strong>` or `<i>`.
|
|
91
|
+
However, this only works for elements without additional attributes (like className), having none or a single text children and provided that we use them in places that allow by design for text formatting.
|
|
92
|
+
|
|
93
|
+
## E2E Tests
|
|
94
|
+
|
|
95
|
+
This repository uses [Playwright](https://playwright.dev/) framework for testing and automation.
|
|
96
|
+
|
|
97
|
+
### pipeline
|
|
98
|
+
|
|
99
|
+
End-to-end tests could be executed by using dedicated `GitHub Actions` workflow.
|
|
100
|
+
By default the `Playwright Tests` is triggered for each pull request created in the repository.
|
|
101
|
+
|
|
102
|
+
The pipeline could be also triggered manually by using `Run workflow` feature in `GitHub Actions`.
|
|
103
|
+
|
|
104
|
+
The `docker` image used in pipeline is coupled with `Playwright` version installed as NPM dependency.
|
|
105
|
+
|
|
106
|
+
### AIO tests
|
|
107
|
+
|
|
108
|
+
The **Playwright** and tests are fully integrated with AIO test management tool.
|
|
109
|
+
The end-to-end tests codebase could contain `tags` which refers to specific AIO test cases.
|
|
110
|
+
|
|
111
|
+
During manual pipeline execution - the `test_cycle_id` argument could be used to execute only tests cases included in
|
|
112
|
+
AIO Test Cycle and automatically update execution results.
|