Update build instructions (#2681)

dpwatrous · web-flow · commit 709ea98e42f2 · 2023-03-17T14:18:56.000-04:00
diff --git a/docs/setup.md b/docs/setup.md
@@ -1,106 +1,59 @@
 # Setup your environment
 
-The following are instructions for building and running Batch Explorer and the Shared Libraries in a development environment.
+The following are instructions for building and running Batch Explorer in a development environment.
 
 1. Install dependencies:
 
     ```shell
-    npm run dev-setup
     npm install
-    pip3 install -r python/requirements.txt
+    npm run dev-setup
+    pip install -r python/requirements.txt
     ```
 
-2. Build the libraries:
+2. Build the repository:
 
     ```shell
     npm run build
     ```
 
-## Running Batch Shared Libraries Web
+## Running Batch Explorer Desktop Application
 
 ```shell
-npm run start:web
+npm run launch:desktop # Open the dev server, Electron app and all packages in watch mode
 ```
 
-## Running Batch Explorer Desktop
+This command will enable hot reload for a better development experience. Simply saving a file will cause the UI to refresh with your changes.
 
-```shell
-npm run dev-server # Start the dev server (in one shell)
-npm run dev-electron # Start Electron (in another shell)
-```
-
-The dev-server and dev-electron support hot reload for a better development experience. Simply saving a file will cause the UI to refresh to your updated changes.
-
-*Note:* Changes to any files in the node client directory ('src/client') require restarting the application.
+*Note:* Changes to any files in the node client directory ('desktop/src/client') require restarting the application.
 
 Please also take a look at the [coding guidelines](coding-guidelines.md) for this repo for best practices.
 
 ## Editor
 
 If you're using VSCode (recommended) we suggest you use the following extensions:
 
-* EditorConfig for VS Code (Important)
+* EditorConfig
 * ESLint
-* Debugger for Chrome
-
-## Detailed commands
-
-**Magic command** (starts the server and electron in dev mode)
+* Prettier
+* Markdownlint
+* Stylelint
 
-```shell
-npm run dev
-```
-
-Build project
-
-```shell
-npm run build
-```
-
-Run app
-
-```shell
-npm run electron
-```
+## Other useful commands
 
-Run watch (this will build files on save)
+Run everything except for the Electron shell in watch mode:
 
 ```shell
-npm run watch
+npm run start:desktop
 ```
 
-Run dev server (this will handle the refresh of files and later should have live reload)
+Run **only** the Electron shell in watch mode*:
 
 ```shell
-npm run dev-server
+npm run launch:dev-electron
 ```
 
-Run dev electron (to use the dev server you need to run this)
+Start the experimental web UI in watch mode:
 
 ```shell
-npm run dev-electron
+npm run start:web
 ```
-
-## Working on the Shared Libraries and the Portal Extension
-
-The Portal Extension relies on packages provided by the shared libraries. The portal installs the necessary dependencies that are published on a remote registry. If you want to work on the portal in tandem with local, unpublished versions of the shared libraries, you will need to run the following commands:
-
-1. Install the Batch Utility CLI:
-
-    ```shell
-    npm run dev-setup
-    ```
-
-2. Configure paths to relevant repos:
-
-    ```shell
-    bux configure
-    ```
-
-3. Run the link command:
-
-    ```shell
-    bux link
-    ```
-
-The Portal Extension will now use the shared libraries directly from this repo.
diff --git a/package.json b/package.json
@@ -60,6 +60,7 @@
     "gather-build-results": "bux gather-build-results",
     "launch": "npm run -s launch:web",
     "launch:desktop": "lerna run --parallel workspace:launch:desktop --stream",
+    "launch:dev-electron": "cd desktop && npm run dev-electron",
     "launch:web": "lerna run --parallel workspace:launch:web --stream",
     "lint": "prettier -c . && lerna run --parallel workspace:lint --stream && npm run -s lint:markdown",
     "lint:fix": "prettier -w . && lerna run --parallel workspace:lint:fix --stream && npm run -s lint:markdown",
