Skip to content

Commit e1f5f63

Browse files
committed
combined scripts to be easier to run
1 parent ba387dc commit e1f5f63

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

package-react/DevelopmentSteps.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,20 @@ Download the chrome extension from ***insert url here*** in order to time travel
3333

3434
## Set-Up Examples
3535
**From the package-react directory:**
36+
Execute `package-setup-1` to run:
37+
1. `npm i`
38+
1. Installs all dependencies for the package
3639
1. `npm run install-example`
37-
1. Installs all dependencies for the package and both example apps
40+
1. Installs all dependencies for the example app
3841
2. `npm run link-dependencies`
3942
1. Installs all peer dependencies in our package to ensure there are no duplicates
4043
2. Can see all packages currently linked with *`npm ls -g --depth=0 --link=tr`*
4144
3. `npm run watch`
4245
1. Starts rollup in watch mode and creates dist folder
43-
4. `npm run link-package`
46+
In a new shell (still in the package-react directory), execute `package-setup-2` to run:
47+
1. `npm run link-package`
4448
1. Links React Query Rewind
45-
5. `npm run example`
49+
2. `npm run example`
4650
1. Starts the example server with webpack. Note: this is a hot reload, but it does not always pick up changes to the npm package
4751

4852
# Publishing

package-react/package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@
4848
"link-package": "npm link && (cd example/client && npm link react-query-rewind)",
4949
"link-dependencies": "npm link example/client/node_modules/react example/client/node_modules/react-dom example/client/node_modules/@tanstack/react-query",
5050
"unlink-package": "(cd example/client && npm unlink react-query-rewind) && npm unlink",
51-
"package": "npm i && npm run install-example && npm run link-dependencies && npm run watch && npm run link-package && npm run example"
51+
"package-setup-1": "npm i && npm run install-example && npm run link-dependencies && npm run watch",
52+
"package-setup-2": "npm run link-package && npm run example"
53+
5254
},
5355
"license": "MIT",
5456
"peerDependencies": {

0 commit comments

Comments
 (0)