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-dapp | Beacon SDK types and utilities |
@airgap/beacon-sdk | Multi-wallet connection protocol |
@taquito/taquito | Tezos JavaScript SDK for blockchain interactions |
@taquito/beacon-wallet | Beacon wallet adapter for Taquito |
kukai-embed | Direct Kukai wallet integration |
zustand | Lightweight state management |
next | React framework with App Router |
tailwindcss | Utility-first CSS framework (v4) |
@radix-ui/react-* | Accessible headless UI components |
lucide-react | Beautiful 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