Code Monkey home page Code Monkey logo

web3modal's Introduction

Note

Looking for v2? switch the branch.

๐Ÿ“š Documentation

๐Ÿงช Laboratory

๐Ÿ”— Website

Web3Modal

Your on-ramp to web3 multichain. Web3Modal 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

VITE_PROJECT_ID="your_project_id"
  1. Run npm run watch to build and watch for file changes in a separate tab
  2. Run gallery, laboratory or examples in a separate tab i.e. npm run laboratory

Releasing new versions

Choose the packages you want to update and add a summary.

npm run changeset

Version your latest change(s)

npm run changeset version

Enter prelease mode

npm run changeset pre enter [tag]

Steps

  1. Run npm outdated and update dependencies
  2. Run npm install and verify if everything still works correctly
  3. Merge your feature branch into V4
  4. Create a new branch from V4 and name it with the version tag
  5. Run npm changeset and set new custom version, enter prelease mode first if you want to add a tag to the version.
  6. Update version in ConstantsUtil in @web3modal/scaffold-utils to the correct version
  7. Create a new PR with Release Notes and merge into V4
  8. Checkout V4 and run npm run publish:latest
  9. Draft a new release in GitHub and create new tag
  10. Click on Generate Change and only leave the link with difference. Paste in your changelog from PR.
  11. Check Set as the last release and publish release.
  12. Update Web3Modal for https://web3modal.com/ (https://github.com/WalletConnect/www-web3modal) and create a PR
  13. Update Web3Modal for https://app.web3inbox.com (https://github.com/WalletConnect/web3inbox) and create a PR

Running tests

See <app/laboratory/tests/README.md>

web3modal's People

Contributors

pedrouid avatar svenvoskamp avatar xzilja avatar tomiir avatar crisgarner avatar iljadaderko avatar arein avatar enesozturk avatar dependabot[bot] avatar yzheny avatar arronhunt avatar glitch-txs avatar lukaisailovic avatar cali93 avatar w3stside avatar mirshko avatar chaitanyapotti avatar sheraz-haider avatar chris13524 avatar erin-at-work avatar miohtama avatar alpa-coder avatar chadyj avatar stevemieskoski avatar paromix avatar jinhao-l avatar devceline avatar thealexpatin avatar 0xdaksh avatar filipkozakred avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.