ConnectKit

Connecting a wallet, made simple.

BlockchainReactWeb3
family/connectkitdocs.family.co/connectkitconnectkit

README

connectkit

ConnectKit


ConnectKit is a powerful React 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.

Features


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

and much more...

Quick Start


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

npm


  1. ```sh
  2. npx create-react-app my-app --template cra-template-connectkit
  3. ```

yarn


  1. ```sh
  2. yarn create react-app my-app --template cra-template-connectkit
  3. ```

pnpm


  1. ```sh
  2. pnpm dlx create-react-app ./my-app --template cra-template-connectkit
  3. ```

Documentation


You can find the full ConnectKit documentation in the Family docs here.

API Reference


You can find the full API Reference in the Family docs here.

Examples


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

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

Try in CodeSandbox


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

- Next.js (TypeScript)
- Vite Example (TypeScript)

Running Examples Locally


Clone the ConnectKit project and install the necessary dependencies:

  1. ```sh
  2. $ git clone git@github.com:family/connectkit.git
  3. $ cd connectkit
  4. $ yarn install
  5. ```

and start the code bundler:

  1. ```sh
  2. $ yarn dev:connectkit
  3. ```

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

  1. ```sh
  2. $ yarn dev:vite # Vite
  3. $ yarn dev:nextjs # Next.js
  4. $ yarn dev:cra # Create React App
  5. ```

Contribute


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

Twitter


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

License


See LICENSE for more information.