🚀 create-arkiv-app

The fastest way to build blockchain applications with Arkiv

Create production-ready apps demonstrating Arkiv's powerful features in seconds.

🚀 Quick Start

npx create-arkiv-app@latest my-arkiv-app
cd my-arkiv-app
npm install
npm run dev

That's it! Open http://localhost:3000 to explore Arkiv's powerful blockchain features.

✨ What You Get

� 5 Feature Templates

• 🔧 CRUD - Master basic create, read operations
• ⏰ TTL - Learn entity expiration and extension
• 🗳️ Queries - Advanced filtering with real-time voting
• 📡 Subscriptions - Live blockchain event streaming
• 🏷️ Attributes - Complex metadata and smart queries

⚡ Arkiv Features Demonstrated

• CRUD Operations - Create, read, update entities
• TTL (Time-To-Live) - Smart entity expiration
• Real-time Subscriptions - Live blockchain events
• Advanced Queries - Complex filtering and search
• Rich Attributes - Metadata-driven applications

🎯 Production Ready

• TypeScript - Full type safety
• Next.js 16 - Latest React features
• Tailwind CSS - Modern, responsive UI
• Performance monitoring - Live blockchain metrics

🛠️ CLI Options

npx create-arkiv-app@latest [project-name] [options]

Options:
  -t, --template <name>    Template (crud, ttl, queries, subscriptions, attributes)
  --typescript            Use TypeScript (default: true)
  --skip-install          Skip npm install
  -h, --help              Show help

📋 Interactive Setup

The CLI will prompt you for:

• Project name - Your app's name
• Template choice - Choose from 5 Arkiv feature templates
• TypeScript - Enable/disable TypeScript
• Clean UI - Modern Arkiv-styled interface
• Environment - Testnet configuration

🎯 Templates

� CRUD (Recommended)

npx create-arkiv-app@latest --template crud

• Basic entity create and read operations
• Clean Arkiv-styled interface
• Environment variable setup
• Production-ready structure

⏰ TTL (Time-To-Live)

npx create-arkiv-app@latest --template ttl

• Entity expiration management
• Proposal creation and extension
• Real-time countdown display
• TTL best practices

🗳️ Queries

npx create-arkiv-app@latest --template queries

• Advanced filtering and search
• Real-time voting system
• Complex query examples
• Vote tallying with live results

📡 Subscriptions

npx create-arkiv-app@latest --template subscriptions

• Real-time blockchain events
• Live entity creation monitoring
• Event streaming interface
• WebSocket-style updates

🏷️ Attributes

npx create-arkiv-app@latest --template attributes

• Rich metadata management
• Complex filtering systems
• Multi-attribute queries
• Task management examples

🔧 Configuration

Environment Setup

# Copy and edit your environment
cp .env.example .env.local

# Add your Arkiv private key
NEXT_PUBLIC_PRIVATE_KEY=your_private_key
# or
NEXT_PUBLIC_ARKIV_PRIVATE_KEY=your_private_key

Network Options

• Mendoza Testnet - Free development (default)
• Custom Network - Your own Arkiv network

📂 Project Structure

my-arkiv-app/
├── src/
│   ├── app/
│   │   ├── page.tsx        # Main template page
│   │   ├── layout.tsx      # App layout
│   │   └── globals.css     # Global styles
│   └── lib/               # Utilities (if needed)
├── .env.local             # Environment variables
├── package.json           # Dependencies
├── tailwind.config.js     # Tailwind CSS config
├── next.config.js         # Next.js config
└── README.md              # Template documentation

🌟 Key Features Demonstrated

• ✅ CRUD Operations - Entity create, read, update operations
• ⏰ TTL Management - Entity expiration and extension
• 📡 Real-time Events - Live blockchain subscriptions
• 🔍 Advanced Queries - Complex filtering and search
• 🏷️ Rich Attributes - Metadata-driven applications
• 🎨 Modern UI - Clean Arkiv-styled interface

🚀 Deployment

Your app is ready for production deployment:

npm run build  # Build for production
npm start      # Start production server

Deploy to:

• Vercel (recommended)
• Netlify
• Railway
• Any Node.js hosting

🤝 Community

• Arkiv Documentation
• Arkiv SDK
• GitHub
• Mendoza Explorer

📚 Learn More

Guides

• Getting Started with Arkiv
• CRUD Operations
• TTL Management
• Advanced Queries
• Real-time Subscriptions

API Reference

• Arkiv SDK Documentation
• Client Configuration
• Entity Operations

🎯 Next Steps

1. Explore templates - Try all 5 Arkiv feature templates
2. Customize logic - Modify entity operations for your use case
3. Enhance UI - Build on the clean Arkiv-styled interface
4. Deploy live - Share your Arkiv application with the world!

Built with ❤️ by DruxAMB

Explore the power of Arkiv blockchain with beautiful, production-ready templates.