The Vechain DAppKit is a TypeScript library that facilitates seamless interaction between vechain wallets (veworld, sync2) and dApps, enhancing user experience and developer convenience. Please refer to Vechain Docs for full documentation and usage.

• Why ?
• Key features
• Contributing
• Sample Projects
• Branching Strategy
• Setting up for local development
  • Prerequisites
  • Install & build dependencies
  • Run in Dev Mode
• Further Documentation & Usage

• Allow easy interaction with all wallets.
• Currently, connex only plays nice with Sync / Sync2
• Enable a better UX for users

Key Features a.k.a scope

1. wallet connectivity

   key components that handle interaction with veworld and sync 2

2. customizable UI

   ability to totally customize the UI of components

3. User Experience

   Consistent experience with Ethereum and other chains

4. Developer friendly

   Easy to adopt with proper documentation.

• Please refer to the Contributing Guide for more information on how to contribute to the project.

• Look at some live demos here:
  • VueJs Demo
  • VanillaJS Demo
• Refer to the apps folder for sample projects.

Welcome to our project! Here's an overview of our branching strategy.

• main: The main branch represents the production-ready code. Only stable and tested features should be merged into this branch. Once ready for publishing, a new tag should be created from this branch.

• Node.js >= 18.17
• Yarn >= 1.22.10

yarn install:all

yarn dev

yarn test

yarn clean

• Runs yarn clean and removes all node_modules

yarn purge

yarn

yarn build:deps

yarn build

We utilize Cucumber.js with Selenium for end-to-end (E2E) testing. To conduct these tests, you'll require the ChromeDriver. Here's how to install it:

On Mac:

brew install chromedriver
cd "$(dirname "$(which chromedriver)")"
xattr -d com.apple.quarantine chromedriver

Once installed, you can run tests in the browser using:

yarn test:e2e

Alternatively, you can run headless tests directly in the console using:

yarn test:e2e:headless

• Please refer to Vechain Docs for more information on how to use the library.

git clone [email protected]:vechainfoundation/vechain-dapp-kit.git
cd vechain-dapp-kit
git checkout X.Y.Z
yarn install:all
yarn build:release X.Y.Z
yarn changeset publish