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
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,8 +58,9 @@ If they are not installed, follow the steps on [npm Docs](https://docs.npmjs.com
58
58
### 2. To run end-to-end tests, please install 'serve' globally in your machine:
59
59
60
60
```sh
61
-
npm i -g serve
61
+
npm install -g serve
62
62
```
63
+
If you are getting some errors after using that command and you are on Linux/MacOS, try running it as a superuser (sudo)
63
64
64
65
### 3. Afterwards, clone this repo:
65
66
@@ -71,6 +72,13 @@ Now, you should have everything that you need to proceed! Navigate into the fold
71
72
72
73
## :book: Getting Started
73
74
75
+
### 0. Before trying out any of the next commands:
76
+
77
+
```sh
78
+
npm install
79
+
```
80
+
If you get some vulnerability warnings after executing this command, don't worry ;), it's the React team that has to do some catch-up...
81
+
74
82
### 1. In the project directory, you can run:
75
83
76
84
```sh
@@ -88,8 +96,12 @@ You may also see any lint errors in the console.
88
96
```sh
89
97
npm test
90
98
```
99
+
```sh
100
+
a
101
+
```
91
102
92
103
This launches the test runner in the interactive watch mode. :point_up_2:\
104
+
Clicking on the 'a' key runs all tests (excluding End-to-End tests).
93
105
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
94
106
95
107
### 3. To view full tests and code coverage for our code:
@@ -112,8 +124,9 @@ See the section about [deployment](https://facebook.github.io/create-react-app/d
112
124
```sh
113
125
PORT=4571 serve -s build & npm run test:e2e
114
126
```
127
+
'PORT=4571' is used to set the port where the production server will be listening for incoming connections. We decided to use a very specific number so that it doesn't interfere with any of your servers <3 (especially if you are testing multiple apps for some scholar reason?)
115
128
116
-
We are big on testing, so we're using Puppeteer to automate our end to end testing! Puppeteer requires a running production server to test our awesome app. If the commands above do not work for you, please feel free to raise an issue :)
129
+
We are big on testing, so we're using Puppeteer to automate our end to end testing! Puppeteer requires a running production server to test our awesome app. If the commands above do not work for you, please feel free to raise an issue :).
117
130
118
131
### 5. To customise your React configs in-depth and detach from react-scripts:
0 commit comments