Skip to content

Commit 95be5f4

Browse files
committed
Update readme file
update readme.md
1 parent 3cdb0cb commit 95be5f4

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[![GitHub last commit](https://img.shields.io/github/last-commit/lqthang2204/BDDDevicesAutomation.svg)](https://github.com/lqthang2204/BDDDevicesAutomation/commits/main)
44
# BDDDevicesAutomation
55

6-
### About this project
6+
### Overview
77

8-
* The project holds all automation tests for multi-project by browser and mobile (android and ios)
8+
The BDDDevicesAutomation repository is designed for automating tests using Behavior-Driven Development (BDD) with Behave and Selenium, covering web, mobile, and API testing. It’s ideal for developers and testers working on multi-project automation, especially for Chrome, with reusable steps for web UI actions and verifications.
99

1010
### Why do I need this project?
1111

@@ -14,34 +14,33 @@ This project is for chrome
1414
* This project will provide tests specific to performing various browser UI actions and verifications.
1515
* The project will provide the use of the same steps for Web.
1616

17-
### When and why would I need to modify this project?
17+
### Getting Started
18+
To use the repository, clone it from GitHub, set up a virtual environment, and install dependencies with pip install -r requirements.txt. Ensure Python 3.x and necessary drivers for Selenium are installed. For IDE setup, consider PyCharm, with guidance at JetBrains PyCharm Download Page.
1819

19-
Any QA or Developer can contribute to this project for valid acceptable scenarios as below:
2020

21-
. Add a new test or feature file of clubbing various tests.
22-
. There is an error with an existing test and needs to be updated.
23-
. There is missing documentation.
24-
. Any other case that should be brought up to QA leads.
25-
26-
### How do I set up Pychamr?
21+
### How do I get the code, afresh?
2722

28-
Review the https://www.jetbrains.com/idea/download/#section=windows, which addresses
29-
questions such as:
23+
. You can download code at https://github.com/lqthang2204/BDDDevicesAutomation
24+
. Clone this project to a working folder on your local machine.
25+
Follow https://github.com/lqthang2204/BDDDevicesAutomation for cloning a repository.
3026

31-
. How do I import the code into Pycharm?
32-
. How do I check out and change GIT branches?
33-
. What are environment variables and how to configure them for running tests?
27+
### Running Tests
28+
Run tests using commands like python project_runner.py run -fd 'features/scenarios/web' -tg '{@web}' -fk 3 -sg SIT -pl WEB -ps scenario. Parallel testing is supported with behavex -t @regression --parallel-processes 2, and remote testing with Saucelabs is possible.
3429

35-
### How do I get the code, afresh?
30+
### Prerequisites
31+
Before diving in, ensure the following are installed and configured:
3632

37-
. You can download code at https://github.com/lqthang2204/Selenium-with-python-behave
38-
. Clone this project to a working folder on your local machine.
39-
Follow https://github.com/lqthang2204/Selenium-with-python-behave for cloning a repository.
33+
* Python: Version 3.x, with 3.9 or higher recommended for compatibility.
34+
* Behave: The BDD framework for Python, essential for running feature files.
35+
* Selenium: Required for browser and device automation, particularly for web and mobile testing.
36+
* Additional Dependencies: Install any other packages listed in the requirements.txt file, which can be done via:
4037

41-
### Test execution
38+
**pip install -r requirements.txt**
39+
* Device Access: For mobile testing, ensure access to emulators or physical devices, along with necessary drivers.
40+
* IDE: An Integrated Development Environment like PyCharm or VS Code is recommended for development, with setup guidance available at JetBrains PyCharm Download Page.
4241

4342
#### How do I run an automation test?
44-
43+
The repository provides several commands for test execution, detailed in the table above. For example:
4544
* Recommended VM options :
4645
* Recommended Command for CLI
4746
* HELP : ```python project_runner.py run --help```

0 commit comments

Comments
 (0)