Skip to content

Commit 559f3a1

Browse files
authored
Update README.md
Readme edit WIP
1 parent 85d86a1 commit 559f3a1

File tree

1 file changed

+35
-59
lines changed

1 file changed

+35
-59
lines changed

README.md

Lines changed: 35 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -2,68 +2,40 @@
22

33
Spearmint helps developers easily create functional React/Redux/Endpoint/Paint Timing tests without writing any code. It dynamically converts user inputs into executable Jest test code by using DOM query selectors provided by @testing-library.
44

5-
# How to use
5+
# Installation
6+
Please download spearmint from our [website](https://www.spearmintjs.com/). Available for Mac OS, Windows and Linux.
67

7-
Download spearmint @ spearmintjs.com. Available for Mac OS and Windows.
8+
# How to use in development mode
89

9-
<br>
10-
11-
### React Testing
12-
<hr>
13-
To run React tests generated by spearmint, install the following in your dev dependencies.
14-
15-
npm i -D jest @testing-library/jest-dom @testing-library/react test-data-bot
16-
17-
To run Redux tests generated by spearmint, install the following in your dev dependencies, in addition to your React test installations above.
18-
19-
npm i -D redux-mock-store redux-thunk fetch-mock
20-
21-
To run Hooks / Context tests generated by spearmint, install the following in your dev dependencies, in addition to your React test installations above.
22-
23-
npm i -D @testing-library/react-hooks
24-
25-
<br>
26-
27-
### Endpoint Testing
28-
<hr>
29-
To run Endpoint tests generated by spearmint, install the following in your dev dependencies.
30-
31-
npm i -D jest supertest
10+
### For Mac developers
3211

33-
<br>
34-
35-
### Puppeteer Testing
36-
<hr>
37-
To run Puppeteer tests generated by spearmint, install the following in your dev dependencies.
38-
39-
npm i -D jest puppeteer
12+
**Prerequisite**: Install Xcode
4013

14+
First install
15+
1. Fork and clone this repository.
16+
2. ```npm run install-once```
17+
3. ```npm run start```
4118

42-
<br>
43-
44-
### Accessiblity Testing
45-
<hr>
19+
***
4620

47-
To run Accessibility tests generated by spearmint on HTML, install the following in your dev dependencies.
21+
### For Windows developers
4822

49-
npm i -D axe-core regenerator-runtime jest
23+
**Prerequisite**: Install Python and Microsoft C++ Build Tools.
5024

51-
To run Accessibility tests generated by spearmint on React Components, install the following in your dev dependencies.
25+
In an Administrator PowerShell run the following command:
26+
```choco install python visualcpp-build-tools -y npm config set msvs_version 2017```
27+
28+
1. Fork and clone this repository.
29+
2. ```npm run install-once```
30+
3. ```npm run start-windows```
5231

53-
npm i -D axe-core regenerator-runtime jest enzyme enzyme-adapter-react-16
5432

55-
To run Accessibility tests generated by spearmint on URL's with Puppeteer, install the following in your dev dependencies.
56-
57-
npm i -D axe-core puppeteer
58-
59-
60-
<br>
6133

6234
# How it works
6335

64-
1. On the initial screen, enter the URL of your project and load your application to start creating tests.
36+
1. On the initial screen, load your application to start creating tests.
6537

66-
![](https://lh4.googleusercontent.com/CAFpoefRUUxgNosudQuc7gabSReFiI_puZ_WTjrzUSzB6pgOUdQ1babF2mxJql2lC8TQ-jjVLOgG5Qka8SUfF2fi-u2H9xSP7rZ_0Udpj-ISFPAY028UYKIUZcgOApnipVZwE7xh)
38+
![](/public/spearmint_open_folder_page.JPG)
6739

6840
2. Utilize our auto-complete, drop-down options, and tooltips features to easily create arrangement, action, and assertion test statements for React; reducer, action creator, asynchronous action creator, and middleware test statements for Redux; and hooks, context, and endpoint test statements.
6941

@@ -73,7 +45,7 @@ To run Accessibility tests generated by spearmint on URL's with Puppeteer, insta
7345

7446
4. Spearmint will then convert user input to dynamically generate a test file that will be saved inside a **tests** folder, which you can use to run ‘npm test’ on.
7547

76-
![](/public/testfile.png?raw=true)
48+
7749

7850
<br>
7951

@@ -84,24 +56,28 @@ To run Accessibility tests generated by spearmint on URL's with Puppeteer, insta
8456
> Alfred [@astaiglesia](https://github.com/astaiglesia) &nbsp;&middot;&nbsp;
8557
> Annie [@annieshinn](https://github.com/annieshinn) &nbsp;&middot;&nbsp;
8658
> Ben [@bkwak](https://github.com/bkwak) &nbsp;&middot;&nbsp;
87-
> Charlie [@charlie-maloney](https://github.com/charlie-maloney) <br />
59+
> Charlie [@charlie-maloney](https://github.com/charlie-maloney) &nbsp;&middot;&nbsp; <br />
8860
> Chloe [@HeyItsChloe](https://github.com/HeyItsChloe) &nbsp;&middot;&nbsp;
8961
> Cornelius [@corneeltron](https://github.com/corneeltron) &nbsp;&middot;&nbsp;
9062
> Dave [@davefranz](https://github.com/davefranz) &nbsp;&middot;&nbsp;
91-
> Evan [@Berghoer](https://github.com/Berghoer) &nbsp;&middot;&nbsp;
92-
> Gabriel [@bielchristo](https://github.com/bielchristo) <br />
63+
> Dieu [@dieunity](https://github.com/dieunity) &nbsp;&middot;&nbsp;
64+
> Evan [@Berghoer](https://github.com/Berghoer) &nbsp;&middot;&nbsp; <br />
65+
> Gabriel [@bielchristo](https://github.com/bielchristo)
9366
> Johnny [@johnny-lim](https://github.com/johnny-lim) &nbsp;&middot;&nbsp;
9467
> Julie [@julicious100](https://github.com/julicious100) &nbsp;&middot;&nbsp;
95-
> Karen [@karenpinilla](https://github.com/karenpinilla) &nbsp;&middot;&nbsp;
68+
> Justin [@JIB3377](https://github.com/JIB3377) &nbsp;&middot;&nbsp;
69+
> Karen [@karenpinilla](https://github.com/karenpinilla) &nbsp;&middot;&nbsp; <br />
9670
> Linda [@lcwish](https://github.com/lcwish) &nbsp;&middot;&nbsp;
97-
> Luis [@Luis-KM-Lo](https://github.com/Luis-KM-Lo) <br />
71+
> Luis [@Luis-KM-Lo](https://github.com/Luis-KM-Lo) &nbsp;&middot;&nbsp;
72+
> Max [@MaxWeisen](https://github.com/MaxWeisen) &nbsp;&middot;&nbsp;
9873
> Mike [@mbcoker](https://github.com/mbcoker) &nbsp;&middot;&nbsp;
99-
> Natlyn [@natlynp](https://github.com/natlynp) &nbsp;&middot;&nbsp;
74+
> Mo [@mhmaidi789](https://github.com/mhmaidi789) &nbsp;&middot;&nbsp; <br />
75+
> Natlyn [@natlynp](https://github.com/natlynp) &nbsp;&middot;&nbsp;
10076
> Nick [@nicolaspita](https://github.com/nicolaspita) &nbsp;&middot;&nbsp;
10177
> Rachel [@rachethecreator](https://github.com/rachethecreator) &nbsp;&middot;&nbsp;
102-
> Sean [@sean-haverstock](https://github.com/Sean-Haverstock) <br />
103-
> Sharon [@sharon-zhu](https://github.com/sharon-zhu) &nbsp;&middot;&nbsp;
78+
> Sean [@sean-haverstock](https://github.com/Sean-Haverstock) &nbsp;&middot;&nbsp; <br />
79+
> Sharon [@sharon-zhu](https://github.com/sharon-zhu) &nbsp;&middot;&nbsp;
10480
> Sieun [@sieunjang](https://github.com/sieunjang) &nbsp;&middot;&nbsp;
10581
> Tolan [@taoantaoan](https://github.com/taoantaoan) &nbsp;&middot;&nbsp;
106-
> Tristen [@twastell](https://github.com/twastell) <br />
107-
<hr>
82+
> Tristen [@twastell](https://github.com/twastell)
83+
<hr>

0 commit comments

Comments
 (0)