Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.71 KB

development.md

File metadata and controls

40 lines (31 loc) · 1.71 KB

Development

Workspace setup

Install dependencies from the repository's root directory (this will also set up each workspace):

yarn

.env.local file setup

Some examples have .env.local.example files. Copy their content and create new .env.local files in the same directory. Without these yarn:build command will fail. To create your ProjectID head to cloud.walletconnect.com

Commands

  • yarn build - Build all packages.
  • yarn dev - Build and watch all packages for changes.
  • yarn dev:react - Run react example (has to be ran together with yarn dev in a separate terminal tab).
  • yarn dev:react-standalone - Run react standalone example (has to be ran together with yarn dev in a separate terminal tab).
  • yarn dev:html - Run plain html/js example (has to be ran together with yarn dev in a separate terminal tab).
  • yarn dev:html-standalone - Run plain html/js standalone example (has to be ran together with yarn dev in a separate terminal tab).
  • yarn build - Build all packages + examples.
  • yarn lint - Run the linter.
  • yarn prettier - Run prettier.
  • yarn typecheck - Run typescript checks.

Repository structure

  • chains - Helper packages for managed chain workflows
  • examples - Contains examples for all suported use cases, acts as testing ground
  • packages
    • core - State, proxy between ui and chain packages
    • ui - Web-components based ui of web3modal
      • components - Basic ui components
      • partials - Complex ui peaces composing multiple components and accessing core
      • vies - Full web3modal views
    • react - React wrapper on top of core and ui
    • html - Vanilla html / js wrapper on top of core and ui