Skip to content

Commit cd82488

Browse files
authored
Made setup and installation instructions clearer
1 parent f121f95 commit cd82488

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ If they are not installed, follow the steps on [npm Docs](https://docs.npmjs.com
5858
### 2. To run end-to-end tests, please install 'serve' globally in your machine:
5959

6060
```sh
61-
npm i -g serve
61+
npm install -g serve
6262
```
63+
If you are getting some errors after using that command and you are on Linux/MacOS, try running it as a superuser (sudo)
6364

6465
### 3. Afterwards, clone this repo:
6566

@@ -71,6 +72,13 @@ Now, you should have everything that you need to proceed! Navigate into the fold
7172

7273
## :book: Getting Started
7374

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+
7482
### 1. In the project directory, you can run:
7583

7684
```sh
@@ -88,8 +96,12 @@ You may also see any lint errors in the console.
8896
```sh
8997
npm test
9098
```
99+
```sh
100+
a
101+
```
91102

92103
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).
93105
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
94106

95107
### 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
112124
```sh
113125
PORT=4571 serve -s build & npm run test:e2e
114126
```
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?)
115128

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 :).
117130

118131
### 5. To customise your React configs in-depth and detach from react-scripts:
119132

0 commit comments

Comments
 (0)