@ututrust/web-components 2.3.0 → 3.0.0-alpha.0

package/README.md

@@ -24,15 +24,16 @@ $ npm install @ututrust/web-components
 
 ## Configuration options 
 
-The SDK can be configured by dispatching an `utuConfig` event. It 
-currently supports only one element: `production` (`boolean`).
+The SDK can be configured by calling a function on the SDK to inform it what the environment is so 
+that the SDK talks to the correct endpoints:
 
-If set to `true`, the SDK will connect to UTU's production API services. 
-Otherwise (default), it will connect to UTU API testing services.
-
-Use it like so, after the SDK has been loaded:
 ```
-window.dispatchEvent(new CustomEvent("utuConfig", { detail: { production: true } }));
+const config: IConfig = {
+      production,
+      provider: walletProvider
+    };
+
+updateConfig(config);
 ```
 
 ## Examples
@@ -224,6 +225,20 @@ To mock an UTU API response, specify ```api-url``` of ```<x-utu-root>```:
 
 Example of a JSON file can be find at ```/packages/utu-web-components/src/api-mock```
 
+## Using / Not using Unlock
+
+Unlock is a library that allows us to charge for access to signal.  The SDK can be built / run with unlock integrated or not integrated.  This is controlled by an .env file.
+
+Please copy .env_example and rename it to .env
+
+Inside the .env file it has:
+
+```
+VITE_USE_UNLOCK=false
+```
+
+If you want to use Unlock set the above variable to true
+
 ## Local Development
 Development stack:
 - [preactjs](https://preactjs.com)
@@ -247,13 +262,30 @@ Install dependencies
 $ npm install
 ```
 
-Start watch mode with preview in a browser
+Start watch mode with preview in a browser.
 
 ```bash
 $ npm run dev
 ```
+To mock out talking to the UTU backend run this command in another terminal window:
+
+```
+npm run api-mock
+```
+
+To mock out the video recording make sure you are in this directory:
+
+```
+<project-dir>/packages/video-server-mock
+```
+
+and run this command in another terminal window:
+
+```
+npm run start
+```
 
-Production build
+To test that there are no compilation issues in the Production build run:
 
 ```bash
 $ npm run build
@@ -304,16 +336,15 @@ git checkout -b release-[version]
 
 ```
 
-➡️ In `FeedbackDetails.tsx`
+➡️ To get  `FeedbackDetails.tsx` to NOT use Unlock for showing feedback you need to set the .env file to have this attribute:
 
-Ensure the `UnlockGateway` tags are **active**:
+```
+VITE_USE_UNLOCK=false
+```
 
-```tsx
-<UnlockGateway address={sourceUuid}>
-   ...feedback details...
-</UnlockGateway>
+Internally it will not inject the UnlockGateway tags
 
-```
+Note that Unlock functionality is about the user paying to see Signal.
 
 ➡️ In `package.json`
 
@@ -342,23 +373,22 @@ git pull
 
 # create + switch to a staging branch
 git checkout -b release-[version]-alpha
-
 ```
 
-➡️ In `FeedbackDetails.tsx`
+➡️ To get  `FeedbackDetails.tsx` to use Unlock for showing feedback you need to set the .env file to have this attribute:
 
-Comment out the `UnlockGateway` tags before building:
+```
+VITE_USE_UNLOCK=true
+```
 
-```tsx
-{/* <UnlockGateway address={sourceUuid}> */}
-   ...feedback details...
-{/* </UnlockGateway> */}
+Internally it will inject the UnlockGateway tags
+
+Note that Unlock functionality is about the user paying to see Signal.
 
-```
 
 ➡️ In `package.json`
 
-Update the version number with an alpha tag (e.g. `1.2.3-alpha`)
+Update the version number with an alpha tag (e.g. `1.2.3-alpha.0`)
 
 ```bash
 git add .