@worldcoin/idkit
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

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

Package Sidebar

Install

npm i @worldcoin/idkit

Weekly Downloads

678

Version

1.2.0

License

MIT

Unpacked Size

88.1 kB

Total Files

10

Last publish

Collaborators

  • andy_tfh
  • kszarek-tfh
  • juan-tfh
  • penryn
  • lukejmann
  • worldcoinops
  • m1guelpiedrafita
  • paolodamico