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
+46-55Lines changed: 46 additions & 55 deletions
Original file line number
Diff line number
Diff line change
@@ -2,80 +2,67 @@
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
8
9
-
<br>
9
+
# How to use in development mode
10
10
11
-
### React Testing
12
-
<hr>
13
-
To run React tests generated by spearmint, install the following in your dev dependencies.
11
+
### For Mac developers
14
12
15
-
npm i -D jest @testing-library/jest-dom @testing-library/react test-data-bot
13
+
**Prerequisite**: Install Xcode
16
14
17
-
To run Redux tests generated by spearmint, install the following in your dev dependencies, in addition to your React test installations above.
15
+
First install
16
+
1. Fork and clone this repository.
17
+
2.```npm run install-once```
18
+
3.```npm run start```
18
19
19
-
npm i -D redux-mock-store redux-thunk fetch-mock
20
+
***
20
21
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
+
### For Windows developers
22
23
23
-
npm i -D @testing-library/react-hooks
24
+
**Prerequisite**: Install Python and Microsoft C++ Build Tools.
24
25
25
-
<br>
26
-
27
-
### Endpoint Testing
28
-
<hr>
29
-
To run Endpoint tests generated by spearmint, install the following in your dev dependencies.
26
+
In an Administrator PowerShell run the following commands: <br />
To run Puppeteer tests generated by spearmint, install the following in your dev dependencies.
38
37
39
-
npm i -D jest puppeteer
38
+
# How it works
40
39
41
40
42
-
<br>
43
-
44
-
### Accessiblity Testing
45
-
<hr>
41
+
1. On the initial screen, load your application to start creating tests.
46
42
47
-
To run Accessibility tests generated by spearmint on HTML, install the following in your dev dependencies.
43
+
48
44
49
-
npm i -D axe-core regenerator-runtime jest
45
+
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.
50
46
51
-
To run Accessibility tests generated by spearmint on React Components, install the following in your dev dependencies.
47
+
52
48
53
-
npm i -D axe-core regenerator-runtime jest enzyme enzyme-adapter-react-16
49
+
3. Spearmint will then convert user input to dynamically generate a test file, which you can click export icon on the left nav bar to automatically save the test file in the **\_\_tests\_\_** folder.
54
50
55
-
To run Accessibility tests generated by spearmint on URL's with Puppeteer, install the following in your dev dependencies.
56
51
57
-
npm i -D axe-core puppeteer
52
+
4. Lastly click **Run Test** button and follow the guide and click what type of test you would like to perform.
53
+
58
54
55
+
5. Accessibility lens have been added in the app to give developers with different mismatches various options to interact with the app.
56
+
59
57
60
58
<br>
61
59
62
-
# How it works
63
-
64
-
1. On the initial screen, enter the URL of your project and 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
-
70
-
71
60
72
-
3. Refer to the browser view of your app that is displayed on the right to quickly identify values for your selectors and use the file directory to open up a code editor view to easily refer to your codebase for props information.
61
+
# Demo
73
62
74
-
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.
63
+
75
64
76
-
77
-
78
-
<br>
65
+
***
79
66
80
67
### The Spearmint Team
81
68
<hr>
@@ -84,24 +71,28 @@ To run Accessibility tests generated by spearmint on URL's with Puppeteer, insta
84
71
> Alfred [@astaiglesia](https://github.com/astaiglesia) ·
0 commit comments