diff --git a/packages/overmind-devtools-client/package.json b/packages/overmind-devtools-client/package.json index 906f8962..c7849354 100644 --- a/packages/overmind-devtools-client/package.json +++ b/packages/overmind-devtools-client/package.json @@ -17,22 +17,31 @@ "devtool" ], "dependencies": { + "@babel/plugin-transform-runtime": "^7.24.0", + "@babel/preset-react": "^7.23.3", + "@babel/preset-typescript": "^7.23.3", "color-hash": "^2.0.2", "emotion": "^9.2.12", + "html-webpack-plugin": "^5.6.0", "lodash.clonedeep": "^4.5.0", "overmind-react": "next", "react": "^18.2.0", - "react-dom": "^18.2.0", + "react-dom": "^18.2.0", + "react-icons": "^5.0.1", "split-pane-react": "^0.1.3", "tslib": "^2.6.2", "ws": "^8.14.1" }, "devDependencies": { - "@babel/plugin-transform-class-properties": "7.22.5", + "@babel/core": "^7.24.0", + "@babel/plugin-transform-class-properties": "^7.23.3", + "@babel/preset-env": "^7.24.0", "@types/node": "^20.6.1", "@types/ws": "8.5.5", + "babel-loader": "^9.1.3", "terser-webpack-plugin": "^5.3.9", - "webpack": "^5.88.2", + "webpack": "^5.88.2", + "webpack-cli": "^5.1.4", "webpack-merge": "^5.9.0" } } diff --git a/packages/overmind-devtools/README.md b/packages/overmind-devtools/README.md index fffd0165..3545a413 100644 --- a/packages/overmind-devtools/README.md +++ b/packages/overmind-devtools/README.md @@ -1,3 +1,22 @@ -# overmind-devtools +### Introduction -To be filled +This package is one of three packages related to `overmind-devtools`. + +If you're looking for a little deeper insight about these, please check [overmind-devtools-client](../overmind-devtools-client/README.md). + +### Local development + +**PREREQUISITE**: make sure you firstly [built](../overmind-devtools-client/README.md) devtools UI core so that it can be hosted by this package (electron application). + +Considering the above prerequisite is satisfied, run the following steps: +1. Build the host: +```sh +npm run build +``` +2. Run the application: +```sh +npm run prod +``` +3. Use `Application` tab and then clicking on `Open Chrome DevTools`: + +![overmind-devtools-debugging](./docs/assets/overmind-devtools-debugging.png) \ No newline at end of file diff --git a/packages/overmind-devtools/docs/assets/overmind-devtools-debugging.png b/packages/overmind-devtools/docs/assets/overmind-devtools-debugging.png new file mode 100644 index 00000000..998d510e Binary files /dev/null and b/packages/overmind-devtools/docs/assets/overmind-devtools-debugging.png differ diff --git a/packages/overmind-devtools/package.json b/packages/overmind-devtools/package.json index 2b3d4ea0..59c0c774 100644 --- a/packages/overmind-devtools/package.json +++ b/packages/overmind-devtools/package.json @@ -10,8 +10,8 @@ "overmind-devtools": "bin.js" }, "scripts": { - "start": "electron .", - "prod": "NODE_ENV=production electron . --not-packaged=true", + "start": "electron .", + "prod": "NODE_ENV=production electron . --not-packaged=true", "build": "rimraf devtoolsDist && cp -R ../overmind-devtools-client/dist devtoolsDist" }, "keywords": [