@thepalaceproject/circulation-admin 1.34.3-post.6 → 1.34.3-post.7

package/README.md

@@ -83,11 +83,17 @@ Webpack will take care of compiling and updating any new changes made locally fo
 
 This front-end may be run locally in development against a remote Circulation Manager back-end. This removes the need to build a local Circulation Manager from source in order to work on the front-end.
 
-1. Run `npm run dev-server -- --env=backend=[url]` in this `circulation-admin` repository.
+1. Specify a back-end and start the dev server. You have two options:
 
-   Example: `npm run dev-server -- --env=backend=https://gorgon.tpp-qa.lyrasistechnology.org`
+   - Create an `.env` or `.env.local` file in the root of the project and assign `BACKEND=https://gorgon.tpp-qa.lyrasistechnology.org`. Run `npm run dev-server`.
 
-   Note: The tortured syntax here results from going through npm and webpack. The first `--` separates arguments intended for npm from arguments intended for the script that npm runs. In this case the script executes webpack, which allows an environment object to be supplied on the command line using `--env`. Properties of the environment object are specified using the `--env=[property]=[value]` syntax.
+     Note: `dotenv -c` loads `.env.local` then `.env` in that order and will not overwrite variables set by the previous file.
+
+   - Run `npm run dev-server -- --env=backend=[url]` in this `circulation-admin` repository. Providing `--env=backend=` will override `.env` and `.env.local`.
+
+     Example: `npm run dev-server -- --env=backend=https://gorgon.tpp-qa.lyrasistechnology.org`
+
+     Note: The tortured syntax here results from going through npm and webpack. The first `--` separates arguments intended for npm from arguments intended for the script that npm runs. In this case the script executes webpack, which allows an environment object to be supplied on the command line using `--env`. Properties of the environment object are specified using the `--env=[property]=[value]` syntax.
 
 1. Visit `http://localhost:8080/admin/`.
 1. Log in using credentials for the CM back-end. Content from that Circulation Manager should appear.

package/package.json

@@ -29,7 +29,7 @@
     "test-jest": "jest --verbose --roots tests/jest",
     "test-jest-file": "jest --verbose",
     "dev": "webpack --watch --progress --config webpack.dev.config",
-    "dev-server": "webpack serve --progress --hot --config webpack.dev-server.config",
+    "dev-server": "dotenv -c -- webpack serve --progress --hot --config webpack.dev-server.config",
     "dev-test-axe": "TEST_AXE=true npm run dev",
     "prod": "webpack --progress --config webpack.prod.config",
     "build-docs": "typedoc --tsconfig tsconfig.json src"
@@ -92,6 +92,7 @@
     "colors-cli": "^1.0.27",
     "copy-webpack-plugin": "6.4.0",
     "css-loader": "^6.7.2",
+    "dotenv-cli": "^11.0.0",
     "enzyme": "^3.11.0",
     "enzyme-adapter-react-16": "^1.15.6",
     "eslint": "^7.0.0",
@@ -151,5 +152,5 @@
     "*.{js,jsx,ts,tsx,css,md}": "prettier --write",
     "*.{js,css,md}": "prettier --write"
   },
-  "version": "1.34.3-post.6"
+  "version": "1.34.3-post.7"
 }

package/webpack.dev-server.config.js

@@ -36,7 +36,7 @@ const devAssetsPublicPath = "/webpack-dev-assets/";
  * @returns The webpack configuration.
  */
 module.exports = (env) => {
-  const { backend } = env;
+  const backend = env?.backend ?? process.env.BACKEND;
 
   if (!backend) {
     console.error("Please specify the URL of a Circulation Manager back-end.");