starkwebkit

Connecting a wallet, made simple.


Keywords
ens, react-hook, blockchain, hooks, family, ethereum, react
License
BSD-1-Clause
Install
npm install starkwebkit@0.0.1

Documentation

StarkWebKit

StarkWebKit is a powerful React component library for connecting a wallet to your Starknet 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 starkweb.
  • 🖥️ Simple UX — Give users a simple, attractive experience.
  • 🎨 Beautiful Themes — Predesigned themes or full customization.

and much more...

Quick Start

Get started with a StarkWebKit + starkweb project by running one of the following in your terminal:

npm

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

yarn

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

pnpm

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

Documentation

You can find the full StarkWebKit documentation in the StarkWebKit docs here.

API Reference

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

Examples

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

Try in CodeSandbox

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

Running Examples Locally

Clone the StarkWebKit project and install the necessary dependencies:

$ git clone git@github.com:NethermindEth/starkwebkit.git
$ cd starkwebkit
$ 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

Contribute

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

Twitter

Follow @starkwebkit on Twitter for the latest updates on StarkWebKit.

License

See LICENSE for more information.