Skip to content

Commit b807d25

Browse files
authored
Merge pull request #79 from apark0720/master
add README
2 parents f1f6553 + 64736c6 commit b807d25

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
![](https://lh5.googleusercontent.com/5Gr2dZXHJdmIiASsPw9put-6mR20e4g1gOk-af4krREaJ7NqkZnqXLD5QgiotfNHYhGRh387HSqdhjRwxdwOvQzg9ChhfIrZz0FdxVu6gktBtG-sy1MX6Xq36Gmrzu_6G_K7LDQZ)
2+
3+
Spearmint helps developers easily create functional React tests without writing any code. It dynamically converts user inputs into executable Jest test code by using DOM query selectors provided by the react-testing-library.
4+
5+
## How to use
6+
Download spearmint @ spearmintjs.com. Available for Mac OS, Windows, and Linux. To run tests generated by spearmint install jest, jest-dom, react-testing-library, and test-data-bot in your dev dependencies.
7+
8+
npm i -D jest jest-dom @testing-library/react test-data-bot
9+
10+
## How it works
11+
1. On the initial screen, enter the URL of your project and load your React application to start creating tests.
12+
13+
14+
![](https://lh4.googleusercontent.com/CAFpoefRUUxgNosudQuc7gabSReFiI_puZ_WTjrzUSzB6pgOUdQ1babF2mxJql2lC8TQ-jjVLOgG5Qka8SUfF2fi-u2H9xSP7rZ_0Udpj-ISFPAY028UYKIUZcgOApnipVZwE7xh)
15+
16+
2. Utilize our auto-complete, drop-down options, and tooltips features to easily create arrangement, action, and assertion test statements.
17+
18+
19+
![](https://lh5.googleusercontent.com/5VYUlGG5VDdZxdZEh5aokuilhKRp8B5QyVmxvtW_abLYCAzYN-s-el1oV5WMtGuTzbEO2I6l8Ys_yK2gC0fCi8ISHwjh4LlgezsrPWd7mDEtLbPqBYf1J4pgkGmfIV4yq4I_dpQg)
20+
21+
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.
22+
23+
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.
24+
25+
26+
![](https://lh4.googleusercontent.com/zE-ty31I22R7P9-ubFIb4ko6MOBb7r1-56cHX65h9AcF9IsE22RhPKMEdhyR0MJ3PbqNovj1uwxF2T5_klwZ2sWniXfCiXfaEysjQgH5NRskaDFNd-TOGce0oTMn2jPaPEGFHlEq)

0 commit comments

Comments
 (0)