JSPM

takis-idkit-react

2.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 34
  • Score
    100M100P100Q41783F
  • License MIT

The identity SDK. Privacy-preserving identity and proof of personhood with World ID.

Package Exports

  • takis-idkit-react
  • takis-idkit-react/internal

Readme

IDKit JS Widget

This folder (/idkit) contains the main code for the widget. For instructions on how to use the widget, please refer to the repository's main README.

ℹ️ About the Codebase

  • The widget is made to work mainly with vanilla JS code (no framework required). The starting point can be found in src/vanilla.tsx.
  • The React wrapper is found on src/components/IDKitWidget/index.ts.

🧑‍💻 Development & Testing

To develop locally and contribute to this package, you can simply follow these instructions after cloning the repo.

  • Install dependencies
    # be sure to run this in the root folder of the repo
    yarn install
  • Run tests
    # runs in the /idkit folder
    cd idkit/
    yarn test
  • Run local test project
    # runs in the /idkit folder
    yarn dev
  • Open browser at http://localhost:3000
  • To build the production bundle you can simply run.
    # runs in the /idkit folder
    yarn build