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
+54-43Lines changed: 54 additions & 43 deletions
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,34 @@
1
-
1
+
2
2
3
-
Spearmint helps developers easily create functional Accessibility/Endpoint/Puppeteer/React/Hooks/Redux/Vue/Security tests without writing any code. It dynamically converts user inputs into executable Jest test code by using DOM query selectors provided by @testing-library.
3
+
Spearmint helps developers easily create functional Accessibility/Endpoint/GraphQL/Puppeteer/React/Hooks/Redux/Svelte/Vue/Security 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
5
# Installation
6
-
Please download spearmint from our [website](https://www.spearmintjs.com/). Available for Mac OSand Windows.
6
+
Please download spearmint from our [website](https://www.spearmintjs.com/). Available for Mac OS, Windows, and Linux.
7
7
8
8
9
9
# How to use in development mode
10
10
11
-
### For Mac developers
11
+
**Mac Developers**: Install Xcode
12
12
13
-
**Prerequisite**: Install Xcode
13
+
**Windows Developers**: Install Node.js globally
14
14
15
15
1. Fork and clone this repository.
16
16
2.```npm install```
17
17
3.```npm run watch```
18
-
3.```npm run start-dev```
19
-
20
-
***
21
-
22
-
### For Windows developers
23
-
24
-
**Prerequisite**: Install Node.js globally
25
-
26
-
1. Fork and clone this repository.
27
-
2.```npm install```
28
-
3.```npm run watch```
29
-
3.```npm run start-dev```
18
+
4.```npm run start-dev```
30
19
31
20
Note: Windows users may also have to run Spearmint in admin mode
32
21
22
+
5. Create a .env file in the root directory of the project
23
+
6. Insert the following lines of code into the .env file
24
+
```
25
+
APP_DEV=true
26
+
BROWSER=non
27
+
SKIP_PREFLIGHT_CHECK=true
28
+
MONGO_LINK=
29
+
```
30
+
7. Set MONGO_LINK to your MongoDB URI
31
+
33
32
34
33
<br>
35
34
@@ -39,52 +38,48 @@ Note: Windows users may also have to run Spearmint in admin mode
39
38
40
39
1. On the initial screen, a user is prompt to login, sign up (via OAuth or standard sign-up/login), or login as a guest. Once logged in, choose your file and load your application to start creating tests.
41
40
42
-
41
+
43
42
44
-
2. Utilize our auto-complete, drop-down options, and tooltips features to easily create arrangement, action, and assertion test statements for Reactand Vue; reducer, action creator, asynchronous action creator, and middleware test statements for Redux; and hooks, context, and endpoint test statements. Spearmint can save test templates for future use for logged in user (not guests).
43
+
2. Utilize our auto-complete, drop-down options, and tooltips features to easily create arrangement, action, and assertion test statements for React, Vue, and Svelte; reducer, action creator, asynchronous action creator, and middleware test statements for Redux; and hooks, context, endpoint, and GraphQL test statements. Spearmint can save test templates for future use for logged in user (not guests).
45
44
46
-
45
+
47
46
48
47
3. Spearmint will then convert user input to dynamically generate a test file. You can click the export icon on the nav bar to automatically save the test file in the **\_\_tests\_\_** folder to run test or to modify in the future.
49
48
50
-
49
+
51
50
52
51
53
52
4. Lastly click **Run Test** button and follow the guide on the popup and click what type of test you would like to perform.
54
53
55
54
56
-
5. An accessibility lens has been added in the app to give developers with different mismatches various options to interact with the app.
57
55
58
-
56
+
5. The latest version of Spearmint adopted testing capability for Svelte and GraphQL. The [Svelte](https://testing-library.com/docs/svelte-testing-library/intro/) library has been utilized to test your Svelte application.
59
57
60
-
6. Spearmint provides security testing. The [Snyk](https://snyk.io/) library has been utilized to ensure your application is up to snuff for various security standards and protect your application from malicious attacks.
61
-
Users can now test their application for vulnerabilities including: SQL Injection, Cross-site Scripting (XSS), Hardcoded Secrets, and much more!
58
+
62
59
63
-
60
+
# New features with version 0.10.0
64
61
65
-
7. The latest version of Spearmint adopted testing capability for Vue.js. The [Vue Test Utils](https://vue-test-utils.vuejs.org/) library has been utilized to test your Vue.js application.
62
+
* Testing capability for Svelte components
66
63
67
-
64
+
* GraphQL endpoint testing functionality
68
65
69
-
# New features with version 0.9.0
66
+
* Google Oauth
70
67
71
-
*Testing capability for Vue.js
68
+
*Facebook Oauth
72
69
73
-
*Github Oauth login
70
+
*Dependency refactoring
74
71
75
-
*Modernized and upgraded user interface with dark mode option
72
+
*Additional typescript component conversions
76
73
77
-
*Better user experience with draggable modals and exit buttons
74
+
*Logout button
78
75
79
-
* Save test functionality for easier modification of tests
80
-
81
-
* Cross-platform functionality (Mac OS w/ M1 chip, Mac OS w/ Intel chip, Linux/Unix)
76
+
* UI/UX streamlining
82
77
83
78
* Ample bug fixes
84
79
85
80
<br>
86
81
87
-
# Demos
82
+
<!--# Demos
88
83
89
84
### Guest login
90
85
@@ -95,9 +90,21 @@ Users can now test their application for vulnerabilities including: SQL Injectio
95
90
### Github Oauth login
96
91
97
92
93
+
### Facebook Oauth login
94
+
95
+
96
+
### Google Oauth login
97
+
98
+
98
99
### Vue Test
99
100
100
101
102
+
### Svelte Test
103
+
104
+
105
+
### GraphQL Test
106
+
107
+
101
108
### Dark Mode + Upgraded UI/UX
102
109
103
110
@@ -107,7 +114,7 @@ Users can now test their application for vulnerabilities including: SQL Injectio
107
114
### Run a security test
108
115
109
116
110
-
<br>
117
+
<br>-->
111
118
112
119
113
120
# The Spearmint Team
@@ -121,15 +128,19 @@ Users can now test their application for vulnerabilities including: SQL Injectio
121
128
> Charlie [@charlie-maloney](https://github.com/charlie-maloney) <br />
@@ -159,7 +171,6 @@ Users can now test their application for vulnerabilities including: SQL Injectio
159
171
160
172
# If You Want To Contribute:
161
173
The following is a list of features + improvements for future open-source developers that the Spearmint team has either started or would like to see implemented. Or, if you have additional new ideas, feel free to implement those as well!
0 commit comments