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

package/.gitattributes

@@ -0,0 +1,6 @@
+# The selfie guide videos are development assets (public/ is copied to dist only in dev
+# builds, see webpack.config.js) and too large for plain git — 6.9 MB and 5.1 MB — so
+# they live in Git LFS. Production serves them from S3 instead (SELFIE_GUIDE_VIDEO in
+# .env.production, follow-up G1). A clone without git-lfs gets pointer files here and the
+# guide dialog shows an empty player.
+public/video/*.mp4 filter=lfs diff=lfs merge=lfs -text

package/.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+dist
+build
+coverage
+*.min.js

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "singleQuote": true
+}

package/README.md

@@ -102,6 +102,16 @@ For Angular-based projects, you'll need to include the `face-api.js` library in
 }
 ```
 
+## Development
+
+- Node 22 (`.nvmrc`); `npm install`, then `npm run dev` serves `src/index.html` and the
+  debug harnesses on port 8080. `npm run verify` runs the type check and the tests.
+- **Git LFS is required.** The selfie guide videos in `public/video/` are stored with
+  [Git LFS](https://git-lfs.com) (`.gitattributes`). Install it and run `git lfs install`
+  before cloning or pulling; without it those two files check out as small pointer files
+  and the guide dialog plays nothing. `public/` is copied to `dist` by development builds
+  only — production serves the videos from S3 (`SELFIE_GUIDE_VIDEO` in `.env.production`).
+
 ## Acknowledgements
 
 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`