Skip to content

Commit

Permalink
improve setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
kentcdodds committed Oct 8, 2020
1 parent d77d7c6 commit 0a34c6d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,15 @@ should be able to just run a few commands to get set up:
```
git clone https://github.com/kentcdodds/react-fundamentals.git
cd react-fundamentals
npm run setup --silent
node setup
```

This may take a few minutes. **It will ask you for your email.** This is
optional and just automatically adds your email to the links in the project to
make filling out some forms easier.

A few common issues during `npm run setup --silent` have involved PATH variables
(above links or
[here](https://github.com/kentcdodds/react-fundamentals/issues/27)),
A few common issues during `node setup` have involved PATH variables (above
links or [here](https://github.com/kentcdodds/react-fundamentals/issues/27)),
reinstalling git, node, or npm, and clearing npm caches.

If you get any errors, please read through them and see if you can find out what
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"test": "react-scripts test --env=jsdom",
"test:coverage": "npm run test -- --watchAll=false",
"test:exercises": "npm run test -- testing.*exercises\\/ --onlyChanged",
"setup": "node ./scripts/setup",
"setup": "node setup",
"lint": "eslint .",
"validate": "npm-run-all --parallel build test:coverage lint"
},
Expand Down
2 changes: 1 addition & 1 deletion scripts/setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ if (error) {
}

var command =
'npx "git://gist.github.com/bb452ffe53a5caa3600197e1d8005733.git" -q'
'npx "https://gist.github.com/kentcdodds/bb452ffe53a5caa3600197e1d8005733" -q'
console.log(
color('subtitle', ' Running the following command: ' + command),
)
Expand Down
2 changes: 2 additions & 0 deletions setup.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
require('./scripts/setup')

0 comments on commit 0a34c6d

Please sign in to comment.