Skip to content

Commit 157079d

Browse files
authored
QACOE-221: Add README files (#5)
* Update README file and update .gitignore with cypress files * Update README and add COE logo * Update README * Add GitHub actions badge * Fix alignment issue
1 parent 1f0aa4a commit 157079d

File tree

4 files changed

+98
-3
lines changed

4 files changed

+98
-3
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
11

2+
<br />
3+
<div align="center">
4+
<p align="center">
5+
<a href="https://moduscreate.com/"><img src=""/></a>
6+
</p>
7+
</div>
8+
29
# QA CoE Experiments
10+
<!-- CONTENTS -->
11+
## Contents
12+
13+
[Cypress Studio](/cypress-studio/README.md)
314

15+
<!-- CONTRIBUTING -->
416
## Contributing
517

6-
## Contributors
18+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
19+
20+
If you have a suggestion that would make this better, please ask permission for this repo and create a pull request. You can also simply open an issue with the tag "enhancement".
721

8-
TBD
22+
1. Fork the Project
23+
2. Create your Feature Branch (`git checkout -b QACOE-XXX`)
24+
3. Commit your Changes (`git commit -m 'Add more tests'`)
25+
4. Push to the Branch (`git push origin QACOE-XXX`)
26+
5. Open a Pull Request

cypress-studio/.gitignore

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
11
# dependencies
2-
node_modules
2+
node_modules
3+
cypress/results/*
4+
cypress/reports/*
5+
cypress/screenshots/*
6+
cypress/videos/*

cypress-studio/README.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<div id="top"></div>
2+
3+
<!-- PROJECT SHIELDS -->
4+
[![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg)](https://www.cypress.io/)
5+
![example workflow](https://github.com/ModusCreateOrg/qa-coe-experiments/actions/workflows/main.yml/badge.svg)
6+
7+
<!-- PROJECT LOGO -->
8+
<br />
9+
<div align="center">
10+
<p align="center">
11+
<a href="https://www.cypress.io"><img src="https://cloud.githubusercontent.com/assets/1268976/20607953/d7ae489c-b24a-11e6-9cc4-91c6c74c5e88.png"/></a>
12+
</p>
13+
14+
<h3 align="center">Cypress Studio experiment</h3>
15+
</div>
16+
17+
<!-- ABOUT THE PROJECT -->
18+
## About The Project
19+
20+
The main goal of this experiment is to share with the community how `Cypress Studio` feature works and we're open for suggestions that improves the code as well.
21+
22+
<p align="right">(<a href="#top">back to top</a>)</p>
23+
24+
<!-- GETTING STARTED -->
25+
## Getting Started
26+
27+
### Prerequisites
28+
29+
* npm
30+
```sh
31+
npm install npm@latest -g
32+
```
33+
34+
### How to run cypress tests
35+
36+
1. Clone the repo
37+
```sh
38+
git clone https://github.com/ModusCreateOrg/qa-coe-experiments
39+
```
40+
3. Install NPM packages under `cypress-studio` folder
41+
```sh
42+
cd cypress-studio
43+
npm install
44+
```
45+
4. You can run cypress tests in two ways:
46+
47+
* Headless
48+
49+
```javascript
50+
./node_modules/.bin/cypress run
51+
```
52+
or
53+
* Open Cypress Test Runner
54+
```javascript
55+
./node_modules/.bin/cypress open
56+
```
57+
58+
<p align="right">(<a href="#top">back to top</a>)</p>
59+
60+
<!-- CONTACT -->
61+
## Contact
62+
63+
Pedro Hyvo - [@pedrohyvo](https://www.linkedin.com/in/pedrohyvo/)
64+
65+
<p align="right">(<a href="#top">back to top</a>)</p>
66+
67+
68+
<!-- ACKNOWLEDGMENTS -->
69+
## Acknowledgments
70+
71+
* [Cypress Studio documentation](https://docs.cypress.io/guides/core-concepts/cypress-studio)
72+
73+
<p align="right">(<a href="#top">back to top</a>)</p>

imgs/coe-logo-qa.png

17 KB
Loading

0 commit comments

Comments
 (0)