Light

walletconnect / create-wc-dapp Goto Github PK

View Code? Open in Web Editor NEW

26.0 3.0 16.0 3.77 MB

create-wc-dapp is an npx starter template that allows you to easily set up a WalletConnect integrated dApp.

Home Page: create-wc-dapp.vercel.app

License: MIT License

JavaScript 9.52% TypeScript 48.40% CSS 35.08% HTML 6.99%

npx starter-template walletconnect create-wc-dapp

create-wc-dapp's Introduction

CREATE-WC-DAPP

create-wc-dapp is an npx starter template that allows you to easily set up a WalletConnect integrated dApp. With just one command, you can bootstrap your project and get started with WalletConnect v2 and Web3Modal 📲

Features

✨ Seamless integration with WalletConnect v2 and Web3Modal v3 with EIP-6963 support.

📦 Provides three template options: Next.js, React, and Vite.

🧱 Supports multiple library options: Wagmi, Ethers.js.

🔧 Supports multiple package managers: Yarn, npm, and pnpm.

Prerequisites

Before using create-wc-dapp, make sure you have the following:

Node.js (version 12 or higher)
Git

Usage

To create a new WalletConnect integrated dapp, run the following command:

npx create-wc-dapp [options]

Options

-V, --version: Output the version number of CREATE-WC-DAPP.
-i, --install: Install project dependencies after creating the project.
-id, --project-id <projectId>: Enter your project ID from https://cloud.walletconnect.com.
-t, --template <template>: Select a template to use for your WalletConnect dApp. Available choices: "nextjs", "react", "vite".
-p, --package-manager <packageManager>: Select a package manager to use for your WalletConnect dapp. Available choices: "yarn", "npm", "pnpm".
-l, --library <library>: Select a library to use for your WalletConnect. Available choices: "wagmi", "ethers".
-y, --use-default: Use default options for all prompts.
-h, --help: Display the help screen for the command.

Note: Although options can be passed to create-wc-dapp via the command line, you can also use the interactive prompts to select your options.

Running Locally

To run the CLI locally, clone the repository and install the dependencies:

git clone https://github.com/WalletConnect/create-wc-dapp.git
cd create-wc-dapp
yarn

Then, run the following command to start create-wc-dapp:

yarn dev

License

This project is licensed under the MIT license.

Note: This README file is a general overview of create-wc-dapp. For more detailed information, usage examples, and troubleshooting, please refer to the documentation and source code available on the GitHub repository.

create-wc-dapp's People

Contributors

Stargazers

Watchers

Forkers

nownosw gaealimited michaelbjordanshusband westonnelson schezo817 niftrr mxc69sol snak613 jwvegahn yumingvvv ellaspa mabsattar manipulation44 qadirkilledar elijahhero isabella232

create-wc-dapp's Issues

Upgrade to Next 13

Potential Upgrades to create-wc-dapp

Switch to latest Next version
Usage of App router
You can find more about it here

Both package-lock.json and yarn.lock exist

chris13524@peach my-wc-dapp % yarn install
yarn install v1.22.19
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.

Can we prompt the user during setup if they want to use yarn or npm? Similar to npx create-next-app

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

fix(deps): update all non-major dependencies (@tsconfig/node16, @types/node, @types/react, @types/react-dom, @typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint, eslint-plugin-jest, react, react-dom, typescript)
fix(deps): update dependency eslint to v9
fix(deps): update dependency eslint-plugin-jest to v28
fix(deps): update typescript-eslint monorepo to v7 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

npm

core/next-starter-template-ethers/package.json

@types/node 18.19.14

@types/react 18.2.52

@types/react-dom 18.2.18

@web3modal/ethers5 ^3.2.0-alpha.1

eslint 8.56.0

eslint-config-next 13.5.6

ethers 5.7.2

next 13.5.6

react 18.2.0

react-dom 18.2.0

typescript 5.3.3

core/next-starter-template-wagmi/package.json

@types/node 18.19.14

@types/react 18.2.52

@types/react-dom 18.2.18

@web3modal/wagmi 3.5.7

eslint 8.56.0

eslint-config-next 13.5.6

next 13.5.6

react 18.2.0

react-dom 18.2.0

typescript 5.3.3

viem ^1.13.1

wagmi ^1.4.2

core/react-starter-template-ethers/package.json

@web3modal/ethers5 ^3.2.0-alpha.1

ethers 5.7.2

react ^18.2.0

react-dom ^18.2.0

@types/react ^18.0.28

@types/react-dom ^18.0.11

@vitejs/plugin-react ^4.0.0

typescript ^5.0.4

vite ^5.0.0

core/react-starter-template-wagmi/package.json

@web3modal/wagmi 3.5.7

react ^18.2.0

react-dom ^18.2.0

viem ^1.13.1

wagmi ^1.4.2

@types/react ^18.0.28

@types/react-dom ^18.0.11

@vitejs/plugin-react ^4.0.0

typescript ^5.0.4

vite ^5.0.0

core/vanilla-starter-template-ethers/package.json

@web3modal/ethers5 ^3.2.0-alpha.1

ethers 5.7.2

typescript ^5.0.4

vite ^5.0.0

core/vanilla-starter-template-wagmi/package.json

@wagmi/core ^1.4.2

@web3modal/wagmi 3.5.7

viem ^1.13.1

typescript ^5.0.4

vite ^5.0.0

package.json

@jest/globals ^29.5.0

@tsconfig/node16 ^16.0.0

@types/cli-progress ^3.11.0

@types/fs-extra ^11.0.1

@types/jest ^29.5.0

@types/node ^18.15.11

@types/prompts ^2.4.4

@typescript-eslint/eslint-plugin ^6.0.0

@typescript-eslint/parser ^6.0.0

cli-progress ^3.12.0

commander ^11.0.0

eslint ^8.37.0

eslint-config-prettier ^9.0.0

eslint-import-resolver-typescript ^3.5.4

eslint-plugin-import ^2.27.5

eslint-plugin-jest ^27.2.1

fs-extra ^11.1.1

jest ^29.5.0

open ^9.1.0

picocolors ^1.0.0

prettier ^3.0.0

prompts ^2.4.2

ts-jest ^29.1.0

ts-node ^10.9.1

typescript ^5.0.3

Check this box to trigger a request for Renovate to run again on this repository

Upgrade to Web3Modal v4

Synopsis:

create-wc-dapp is currently using Web3Modal v3 and upgrading to v4 requires a few changes code wise due to bump from wagmi v1>v2 and mostly due to the use of @tanstack/react-query (import { QueryClient, QueryClientProvider } from '@tanstack/react-query') which adds native support for Next.js without having to implement any hacky ways to bypass the hydration issues

Details

Upgrade Guide
Documentation about Web3Modal v3.x React
Documentation about Web3Modal v4.x React
Similar documentation about other platforms such as Next, Javascript can be found here

Alpha .2

Tasks

Beta Give feedback

Add W3I dapp
Add W3W wallet
Options

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.