sui-dapp-cli
v1.0.3
Published
A beautiful CLI tool to scaffold Sui dApps with React or Next.js
Maintainers
Readme
Create Sui App 🌊
A beautiful CLI tool to scaffold Sui dApps with React or Next.js, featuring TypeScript and JavaScript support.
✨ Features
- 🎨 Beautiful CLI with Sui-themed colors and animations
- 🚀 Multiple Templates: Next.js and React with TypeScript/JavaScript
- 💼 Wallet Integration pre-configured with @mysten/dapp-kit
- 🔗 Smart Contract Integration template included
- 📱 Responsive Design with Tailwind CSS
- ⚡ Modern Tooling (Vite, Next.js 15, React 18)
🚀 Quick Start
Using npx (recommended)
npx sui-dapp-cli@latestOr global install
npm install -g sui-dapp-cli
sui-dapp-cliAlternative (if you set multiple bin names)
npx sui-dapp📦 Available Templates
Next.js Templates
- Next.js + TypeScript: Full-stack with App Router and type safety
- Next.js + JavaScript: Full-stack with App Router, no TypeScript
React Templates
- React + TypeScript: Client-side with Vite and type safety
- React + JavaScript: Client-side with Vite, no TypeScript
🎯 What You Get
Each template includes:
- ✅ Sui Wallet Integration with connection/disconnection
- ✅ Smart Contract Integration template with examples
- ✅ Modern UI Components with Tailwind CSS
- ✅ Responsive Design that works on all devices
- ✅ Developer Experience with hot reload and fast builds
- ✅ Best Practices for Sui dApp development
🔧 Smart Contract Setup
After creating your project:
- Deploy your Move contract to Sui network
- Update config: Edit
lib/smart-contract/config.jsonwith your addresses - Customize functions: Modify transaction builders and queries
- Test integration: Connect wallet and test your contract
📁 Project Structure
my-sui-app/
├── src/ # Source code
│ ├── components/ # React components
│ ├── lib/smart-contract/ # Smart contract integration
│ ├── pages/ # Page components
│ └── providers/ # React providers
├── public/ # Static assets
├── package.json # Dependencies
└── README.md # Project documentation🛠️ Development
# Install dependencies
npm install
# Start development server
npm run dev
# Build for production
npm run build🎨 CLI Preview
███████╗██╗ ██╗██╗ ██████╗ ███████╗██╗ ██╗
██╔════╝██║ ██║██║ ██╔══██╗██╔════╝██║ ██║
███████╗██║ ██║██║ ██║ ██║█████╗ ██║ ██║
╚════██║██║ ██║██║ ██║ ██║██╔══╝ ╚██╗ ██╔╝
███████║╚██████╔╝██║ ██████╔╝███████╗ ╚████╔╝
╚══════╝ ╚═════╝ ╚═╝ ╚═════╝ ╚══════╝ ╚═══╝
█████╗ ██████╗ ██████╗
██╔══██╗██╔══██╗██╔══██╗
███████║██████╔╝██████╔╝
██╔══██║██╔═══╝ ██╔═══╝
██║ ██║██║ ██║
╚═╝ ╚═╝╚═╝ ╚═╝
⚡ Build dApps on Sui with ease ⚡
Made by DevDanny ❤️
◇ What is your project name?
│ my-awesome-sui-app
│
◆ Select a framework:
│ ● 🚀 Next.js
│ ○ ⚛️ React
└
◆ Select a language:
│ ● 🔷 TypeScript
│ ○ 🟨 JavaScript
└🌈 Features
- Sui-themed colors with beautiful gradients
- Interactive prompts with validation
- Animated spinners during project creation
- Success celebration with next steps
- Error handling with helpful messages
🤝 Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
📄 License
This project is licensed under the MIT License.
🔗 Links
Built with ❤️ for the Sui ecosystem
