README.md

DOT UI Kit

An open-source, up-to-date, opinionated UI scaffolding kit for the Polkadot ecosystem (starting with Asset Hub). The technical stack is:

• Next.js
• Tailwind CSS
• Lucide icons
• ShadCN UI
• RainbowKit
• Wagmi
• Viem
• Jotai
• Tanstack React Query
• Vaul
• Zod
• React Hook Form

Features

• Multi-chain support
• In-dapp-wallet support
• WalletConnect support
• Collection of web3 components to quickly build your frontend or use as a reference
• React hooks for various onchain interactions with Wagmi

Requirements

Before you begin, you need to install the following tools:

• Node (current LTS version)
• npm (latest version or > v10)
• Git

Getting started

git clone https://github.com/buildstationorg/dotui.git
cd dotui
npm install

Running the project

npm run dev

Default port is 3002. You can change the port in the package.json file.

"scripts": {
  "dev": "next dev -p 3002", // Change the port here to -p <port>
  "build": "next build",
  "start": "next start",
  "lint": "next lint"
},

Building the project

npm run build

Documentation

Please see docs for more information and guidelines for contributing to DotUI.

Contributing to DotUI

We welcome contributions to DotUI!

Please see CONTRIBUTING.md for more information and guidelines for contributing to DotUI.