Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 2.22 KB

INSPECTOR.md

File metadata and controls

71 lines (48 loc) · 2.22 KB
Raw

RxPaired-inspector

How to build and run it

To build it, you first need to install its dependencies.

To do that, make sure that you have npm installed and this repository cloned. Then go to this directory on a terminal, and type:

npm install

If not already done, you have to create a .npmrc file in the root directory. You can base yourself on the .npmrc.sample file:

# in root directory
cp .npmrc.sample .npmrc

In that new .npmrc file, you'll need to set two URLs:

  1. inspector_debugger_url:

    This will be the WebSocket address RxPaired-server is listening to for RxPaired-inspector connections.

    If you didn't start the RxPaired-server yet, you should first start doing this by using npm run serve --workspace=server.

    Note that the URL already present uses the default port used by the server. If your server runs locally in the default config, you might not actually have to update it.

    In most cases however, you might want to use HTTPS/WSS instead of the default HTTP/WS (to make the RxPaired-Client runnable in HTTPS pages). There, you might need to update this value to the actual HTTPS URL used.

  2. device_script_url:

    This is the URL the RxPaired-Client (the script that will be deployed to devices) is available at.

    You can leave this URL empty if you do not wish to serve that script though HTTP(S) means. In that case, you will have to copy/paste the content of that script into the HTML page running on the device.

Once this is done, you can start building the RxPaired-inspector.

In your terminal, type:

npm run build:min --workspace="inspector"

You can now start using the RxPaired-inspector, you just need to serve both the inspector/index.html and the newly generated inspector/inspector.js files.

You can do so easily by typing in a terminal:

npm run serve --workspace="inspector"

Multiple persons can even build and serve their own RxPaired-inspector while debugging the same devices as long as the same RxPaired-server is used.

Though you might prefer the simplicity of just letting a "real" HTTP(S) server serve both of those files instead. This way this build step does not need to be repeated for each user.