Skip to content

Commit aa22494

Browse files
added faq section (#88)
1 parent fce55fb commit aa22494

File tree

6 files changed

+1364
-1155
lines changed

6 files changed

+1364
-1155
lines changed

docs/Steps-v1/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Steps v1",
3-
"position": 20,
3+
"position": 2,
44
"link": {
55
"type": "generated-index",
66
"description": "Steps v1"

docs/Steps/wdio-v2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ export default {
8686
```
8787

8888
## Parameter Types
89-
### `playwrightLocator`
89+
### `wdioLocator`
9090
Resolves to playwright locator
9191

9292
### `wdioCondition`

docs/qna.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
sidebar_position: 20
3+
---
4+
5+
# FAQ
6+
7+
## Can I use qavajs for free?
8+
Yes, qavajs can be downloaded and installed using npm
9+
```bash
10+
npm init @qavajs
11+
```
12+
The framework’s source code is available on GitHub under the open-source MIT license.
13+
14+
## What is system requirement for qavajs?
15+
[(Node.js)](https://nodejs.org/en) > 20
16+
17+
## Which browsers does qavajs support?
18+
qavajs works on top of different test automation tools (playwright, webdriverio, cypress).
19+
You can check supported browsers on official pages.
20+
21+
## What programming language do qavajs tests use?
22+
qavajs uses [Gherkin](https://cucumber.io/docs/gherkin/reference) to describe test cases
23+
and JavaScript/TypeScript to define support code (test data, project specific step definitions, etc)
24+
25+
## Can mobile applications be tested with qavajs?
26+
Yes, qavajs can work on top of [webdriverio](Steps/wdio-v2.md) and use appium to run tests on mobile devices.
27+
28+
## Can API be tested with qavajs?
29+
Yes, you can use [API steps](Steps/api-v2.md) to interact with REST, graphQL and websocket services.
30+
31+
## Can I integrate qavajs into my CI workflow?
32+
Yes. qavajs is Node.js application so can be executed on any agent where Node.js installed.
33+
34+
## What programming languages and techniques do I need to know to use qavajs?
35+
Basic JavaScript and Gherkin knowledge is enough to get started with qavajs and follow code examples.
36+
37+
To improve your end-to-end tests you can learn more about the following:
38+
39+
- CSS/xpath selectors
40+
- HTML5 markup
41+
- Browser JavaScript
42+
- Promises and async/await syntax
43+
- Node.js
44+
- TypeScript
45+
46+
## How can I make sure that qavajs is good choice for my project? How can I convince others?
47+
Evaluate qavajs for your project
48+
### Assess Project Requirements:
49+
50+
- Identify key needs such as language compatibility (JavaScript/TypeScript), BDD-style testing, CI/CD pipeline integration, and cross-browser support.
51+
- Check if qavajs meets your specific test automation goals (e.g., API, UI, or performance testing).
52+
53+
### Explore Key Features of qavajs:
54+
55+
- Cucumber-based BDD Framework: Promotes collaboration by allowing non-technical stakeholders to understand and contribute to test cases.
56+
- Cross-Browser Testing: Supports modern browsers, ensuring coverage across platforms.
57+
- JavaScript Ecosystem: Fits well with Node.js-based environments, especially for full-stack JavaScript projects.
58+
- Extensibility: Can integrate with other tools and frameworks, allowing flexibility.
59+
- Parallel Execution: Saves time by running tests simultaneously.
60+
### Run a Proof of Concept (PoC):
61+
62+
- Set up a small qavajs test suite on your application implementing most important test cases.
63+
- Demonstrate its ease of use, speed, and effectiveness for the types of tests your team needs.
64+
- Highlight any issues resolved compared to your current or alternative frameworks.
65+
66+
### Evaluate Against Competitors:
67+
68+
- Compare qavajs with other frameworks providing similar capability.
69+
- Focus on specific needs: e.g., BDD support, customization, or performance.
70+
- Consider factors like community support, ease of learning, and integration options.
71+
72+
### Check Team Readiness:
73+
- Evaluate the team's familiarity with JavaScript, Cucumber, or related technologies.
74+
75+
## Does qavajs collect or share my test data?
76+
qavajs doesn't collect or share any data.
77+
78+
## How do I ask for technical support?
79+
Create an issue in [qavajs core](https://github.com/qavajs/core/issues) repository, qavajs team will answer as fast as possible.

docs/v2.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
sidebar_position: 1
33
---
44

5-
## What's new
5+
# What's new in v2
6+
67
- new page object approach
78

89
page object now is built-in to corresponding UI library and exports single named export `locator` from `/po` sub-path.

0 commit comments

Comments
 (0)