Repository files navigation

ConnectKit is a powerfulReact component library for connecting a wallet to your dApp. It supports the most popular connectors and chains out of the box and provides a beautiful, seamless experience.

• 💡 TypeScript Ready — Get types straight out of the box.
• 🌱 Ecosystem Standards — Uses top libraries such aswagmi.
• 🖥️ Simple UX — Give users a simple, attractive experience.
• 🎨 Beautiful Themes — Predesigned themes or full customization.

and much more...

Get started with a ConnectKit +wagmi +viem project by running one of the following in your terminal:

npx create-react-app my-app --template cra-template-connectkit

yarn create react-app my-app --template cra-template-connectkit

pnpm dlx create-react-app ./my-app --template cra-template-connectkit

You can find the full ConnectKit documentation in the Family docshere.

You can find the full API Reference in the Family docshere.

There are various runnable examples included in this repository in theexamples folder:

• Create React App Example (TypeScript)
• Next.js Example (TypeScript)
• Vite Example (TypeScript)

You can try out some ConnectKit examples directly in your browser through CodeSandbox:

• Create React App Example (TypeScript)
• Next.js (TypeScript)
• Vite Example (TypeScript)

Clone the ConnectKit project and install the necessary dependencies:

$ git clone git@github.com:family/connectkit.git$cd connectkit$ yarn install

and start the code bundler:

$ yarn dev:connectkit$ yarn dev:connectkit-next-siwe

and then simply select the example you'd like to run:

$ yarn dev:vite# Vite$ yarn dev:nextjs# Next.js$ yarn dev:nextjs-siwe# Next.js with SIWE$ yarn dev:cra# Create React App

Before starting on anything, please have a read through ourContribution Guidelines.

Follow@family on Twitter for the latest updates on ConnectKit.

SeeLICENSE for more information.