Tezos LogoTezos Boilerplate

Tezos Wallet Boilerplate Docs

Installation

Get started with the Tezos Wallet Boilerplate in your Next.js project.

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js 18+ or Bun runtime
  • Git for version control
  • A code editor (VS Code recommended)

Clone the Repository

Using Git

# Clone the repository
git clone https://github.com/your-username/nextjs-tezos-wallet-boilerplate.git

# Navigate to the project directory
cd nextjs-tezos-wallet-boilerplate

# Install dependencies
bun install
# or
npm install

Package Dependencies

The boilerplate includes the following key dependencies:

@airgap/beacon-dappBeacon SDK types and utilities
@airgap/beacon-sdkMulti-wallet connection protocol
@taquito/taquitoTezos JavaScript SDK for blockchain interactions
@taquito/beacon-walletBeacon wallet adapter for Taquito
kukai-embedDirect Kukai wallet integration
zustandLightweight state management
nextReact framework with App Router
tailwindcssUtility-first CSS framework (v4)
@radix-ui/react-*Accessible headless UI components
lucide-reactBeautiful icon library

๐Ÿ”„ Auto-Installation

All dependencies are automatically installed when you run bun install or npm install. No additional setup required for wallet providers!

Development Server

Start the development server

# Start the development server
bun dev
# or
npm run dev

# Open http://localhost:3000 in your browser

Project Structure

nextjs-tezos-wallet-boilerplate/
โ”œโ”€โ”€ app/                       # Next.js 15 App Router
โ”‚   โ”œโ”€โ”€ docs/                 # Documentation pages
โ”‚   โ”œโ”€โ”€ globals.css           # Global styles with Tailwind
โ”‚   โ”œโ”€โ”€ layout.tsx            # Root layout with providers
โ”‚   โ””โ”€โ”€ page.tsx              # Main application page
โ”œโ”€โ”€ components/               # React components
โ”‚   โ”œโ”€โ”€ layout/              # Layout components
โ”‚   โ”‚   โ”œโ”€โ”€ Header.tsx       # Navigation header
โ”‚   โ”‚   โ””โ”€โ”€ connect/         # Wallet connection components
โ”‚   โ”œโ”€โ”€ providers/           # React providers
โ”‚   โ”‚   โ””โ”€โ”€ wallet-provider.tsx  # Wallet initialization
โ”‚   โ”œโ”€โ”€ ui/                  # shadcn/ui components
โ”‚   โ”œโ”€โ”€ contract-playground.tsx  # Smart contract interaction
โ”‚   โ”œโ”€โ”€ tez-faucet.tsx       # Testnet token faucet
โ”‚   โ””โ”€โ”€ ...                  # Other dApp components
โ”œโ”€โ”€ lib/                     # Utilities and configuration
โ”‚   โ”œโ”€โ”€ tezos/              # Tezos-specific code
โ”‚   โ”‚   โ”œโ”€โ”€ store/          # Zustand state management
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ walletStore.ts  # Wallet state store
โ”‚   โ”‚   โ””โ”€โ”€ useTezos.tsx    # Main Tezos hook
โ”‚   โ”œโ”€โ”€ constants.ts        # App constants
โ”‚   โ””โ”€โ”€ utils.ts            # Utility functions
โ”œโ”€โ”€ public/                 # Static assets
โ”œโ”€โ”€ package.json           # Dependencies and scripts
โ”œโ”€โ”€ tailwind.config.ts     # Tailwind CSS 4 configuration
โ”œโ”€โ”€ components.json        # shadcn/ui configuration
โ””โ”€โ”€ next.config.mjs        # Next.js configuration

๐Ÿ—๏ธ Architecture Highlights

  • โ€ข App Router: Uses Next.js 15 App Router for optimal performance
  • โ€ข Provider Pattern: WalletProvider handles global wallet state
  • โ€ข State Management: Zustand for lightweight, performant state
  • โ€ข Auto-Restoration: Wallet connections persist across refreshes

Next Steps

๐Ÿ”ง Configuration

Configure network settings and RPC endpoints

Configure your app โ†’

๐Ÿงฉ Components

Learn about the available components

Explore components โ†’