chore: add a utility script to make development easier #512
Conversation
npm run start:using-server will serve the development UI properly wired to a running instance of quipucords server. Default configuration points to quipucords-installer defaults, and can be customized with QUIPUCORDS_SERVER_* variables.
| @@ -28,6 +28,7 @@ | |||
| "build:pre": "bash ./scripts/pre.sh", | |||
| "release": "changelog --link-url https://github.com/quipucords/quipucords-ui.git", | |||
| "start": "export PROTOCOL=http; export HOST=127.0.0.1; export PORT=${PORT:-3000}; export MOCK_PORT=${MOCK_PORT:-3030}; run-p -l api:dev start:js start:open", | |||
| "start:using-server": "export PROTOCOL=${QUIPUCORDS_SERVER_PROTOCOL:-https}; export HOST=${QUIPUCORDS_SERVER_HOST:-127.0.0.1}; export PORT=${PORT:-3000}; export MOCK_PORT=${QUIPUCORDS_SERVER_PORT:-9443}; run-p -l start:js start:open", | |||
There was a problem hiding this comment.
some level of alteration is needed, a couple of choices for you...
Option 1: highly recommend
-
combining the original and new script. reason, currently, the new script is customized for a single developer where as the original
startscript was meant to be expandable for multiple use cases, modifying the original would be naturaltechnically the
npm-run-allis just looking forstringsto runnpm scriptsso replacing it with an exported empty command means it skips it..."start": "export PROTOCOL=${DEV_SERVER_PROTOCOL:-http}; export HOST=${DEV_SERVER_HOST:-127.0.0.1}; export PORT=${DEV_SERVER_PORT:-3000}; export MOCK_PORT=${DEV_SERVER_MOCK_PORT:-3030}; export SERVER_SCRIPT=${DEV_SERVER_SCRIPT:-api:dev}; run-p -l $SERVER_SCRIPT start:js start:open",
Option 2: if the unique script is kept...
start:using-servershould be renamed...- reason, description is generic. technically the original script is also running various servers
- recommend something like
start:custom-serveror something direct likestart:customsince having to continuously type something with a hyphen gets tedious, for those who still reboot/logout their computers =) (there are regrets around theintegration-devscript naming)
And an additional recommendation, but not necessary
- the prefix
QUIPUCORDS_SERVER_should probably be shortened- reason, if the values using
QUIPUCORDS_SERVER_are expected to be typed out by follow up developers we could be kind by shorten them. But, if there's another script exporting these values this is less of a concern.
- reason, if the values using
There was a problem hiding this comment.
I'll try to work with option 1! Better not to have unecessary extra commands.
now, about QUIPUCORDS_ prefixes being long, this is a team decision. We want ALL env vars configuring quipucords to have this prefix, even if it makes them longer.
|
Another recommendation is to update the commit from |
npm run start:using-serverwill serve the development UI properly wired to a running instance of quipucords server. Default configuration points to quipucords-installer defaults, and can be customized with QUIPUCORDS_SERVER_* variables.