You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-59Lines changed: 35 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,68 +2,40 @@
2
2
3
3
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.
4
4
5
-
# How to use
5
+
# Installation
6
+
Please download spearmint from our [website](https://www.spearmintjs.com/). Available for Mac OS, Windows and Linux.
6
7
7
-
Download spearmint @ spearmintjs.com. Available for Mac OS and Windows.
8
+
# How to use in development mode
8
9
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
32
11
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
40
13
14
+
First install
15
+
1. Fork and clone this repository.
16
+
2.```npm run install-once```
17
+
3.```npm run start```
41
18
42
-
<br>
43
-
44
-
### Accessiblity Testing
45
-
<hr>
19
+
***
46
20
47
-
To run Accessibility tests generated by spearmint on HTML, install the following in your dev dependencies.
21
+
### For Windows developers
48
22
49
-
npm i -D axe-core regenerator-runtime jest
23
+
**Prerequisite**: Install Python and Microsoft C++ Build Tools.
50
24
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```
52
31
53
-
npm i -D axe-core regenerator-runtime jest enzyme enzyme-adapter-react-16
54
32
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>
61
33
62
34
# How it works
63
35
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.
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.
69
41
@@ -73,7 +45,7 @@ To run Accessibility tests generated by spearmint on URL's with Puppeteer, insta
73
45
74
46
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.
75
47
76
-

48
+
77
49
78
50
<br>
79
51
@@ -84,24 +56,28 @@ To run Accessibility tests generated by spearmint on URL's with Puppeteer, insta
84
56
> Alfred [@astaiglesia](https://github.com/astaiglesia) ·
0 commit comments