pipwave-ekyc-uikit 3.8.2 → 4.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -102,6 +102,16 @@ For Angular-based projects, you'll need to include the `face-api.js` library in
102
102
  }
103
103
  ```
104
104
 
105
+ ## Development
106
+
107
+ - Node 22 (`.nvmrc`); `npm install`, then `npm run dev` serves `src/index.html` and the
108
+ debug harnesses on port 8080. `npm run verify` runs the type check and the tests.
109
+ - **Git LFS is required.** The selfie guide videos in `public/video/` are stored with
110
+ [Git LFS](https://git-lfs.com) (`.gitattributes`). Install it and run `git lfs install`
111
+ before cloning or pulling; without it those two files check out as small pointer files
112
+ and the guide dialog plays nothing. `public/` is copied to `dist` by development builds
113
+ only — production serves the videos from S3 (`SELFIE_GUIDE_VIDEO` in `.env.production`).
114
+
105
115
  ## Acknowledgements
106
116
 
107
117
  We extend our gratitude to the following open-source projects that greatly contributed to the development of the Pipwave Ekyc Uikit: `pipwave-ekyc-sdk`,`webpack`, `face-api.js`, `moment`, `pikaday`