Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 1.03 KB

README.md

File metadata and controls

35 lines (29 loc) · 1.03 KB
Raw

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