https://github.com/web3modal/web3modal

The full stack toolkit to build onchain app UX
https://github.com/web3modal/web3modal

dapps ethereum integration plugin react wallet walletconnect widget

Last synced: about 1 month ago
JSON representation

The full stack toolkit to build onchain app UX

• Host: GitHub
• URL: https://github.com/web3modal/web3modal
• Owner: reown-com
• License: apache-2.0
• Created: 2018-03-29T06:20:57.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T14:36:11.000Z (about 2 months ago)
• Last Synced: 2024-09-17T14:45:25.195Z (about 2 months ago)
• Topics: dapps, ethereum, integration, plugin, react, wallet, walletconnect, widget
• Language: TypeScript
• Homepage: https://reown.com/appkit
• Size: 77 MB
• Stars: 4,814
• Watchers: 63
• Forks: 1,350
• Open Issues: 91
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> [!NOTE]

> Looking for Web3modal v[1-5]? [switch the branch](https://github.com/WalletConnect/web3modal/tree/V5).

#### 📚 [Documentation](https://docs.reown.com/appkit/about)

#### 🧪 [Laboratory](https://appkit-lab.reown.org)

#### 🔗 [Website](https://reown.com/appkit)

# AppKit

Your on-ramp to web3 multichain. AppKit is a versatile library that makes it super easy to connect users with your Dapp and start interacting with the blockchain.



  



# Dev setup

1. Create `apps/laboratory/.env.local` file using the template from `apps/laboratory/.env.example`

2. In each of the `examples` create `.env.local` file with following contents

```zsh

VITE_PROJECT_ID="your_project_id"

```

3. Run `pnpm watch` to build and watch for file changes in a separate tab

4. Run gallery, laboratory or examples in a separate tab i.e. `pnpm laboratory`

# Releasing new versions

### Enter prelease mode [Optional]

If you need to release a canary/alpha/beta you need to enter prelease mode first

```sh

pnpm changeset:pre 

```

For example: `pnpm changeset:pre a123bas2`

### Generate changeset

If you need to release a canary/alpha/beta you need to enter prelease mode first

```sh

pnpm changeset

```

### Steps

1. Run `pnpm update` and update dependencies

2. Run `pnpm install` and verify if everything still works correctly

3. Merge your feature branch into `main`

4. Changesets action will create or update a release PR

5. When such PR is merged, it will trigger an automatic deploy to npm and publish release on github

### Running tests

See