Skip to content
icekidtechPublic

About

Simple NFT made with Sui Move.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

31 Commits

Folders and files

Repository files navigation

MintMule 🐪

The Premier NFT Launchpad on Sui Blockchain

MintMule is a cutting-edge NFT launchpad that empowers creators to deploy and users to mint unique digital assets on the Sui blockchain. Built with performance, security, and user experience in mind.

Sui Move License

✨ Features

  • 🚀 Easy NFT Minting - Simple, intuitive interface for minting NFTs
  • 🎨 Creator Tools - Powerful tools for NFT creators and collectors
  • 🔒 Secure & Decentralized - Built on Sui's secure blockchain infrastructure
  • 📊 Real-time Analytics - Track your NFT portfolio and performance
  • 🌐 Cross-Platform - Web-based interface with wallet integration
  • ⚡ Fast Transactions - Leverage Sui's high-speed transaction processing

📁 Project Structure

mintmule/
├── sources/
│   └── simple_nft.move      # Core NFT smart contract
├── tests/
│   └── simple_nft_tests.move # Comprehensive test suite
├── frontend/                # React-based dApp frontend
│   ├── src/
│   │   ├── components/      # Reusable UI components
│   │   ├── contexts/        # React contexts for state management
│   │   └── pages/          # Application pages
│   └── ...
├── docs/                    # Comprehensive documentation
│   ├── getting-started.md   # Setup and quick start guide
│   ├── smart-contract.md    # Contract architecture and API
│   ├── deployment.md        # Deployment instructions
│   ├── usage.md            # Usage examples and guides
│   ├── testing.md          # Testing documentation
│   ├── configuration.md    # Configuration options
│   ├── troubleshooting.md  # Common issues and solutions
│   └── architecture.md     # Design decisions and rationale
├── Move.toml               # Package configuration
├── deployment.json         # Deployment information
├── deploy.sh              # Automated deployment script
└── README.md              # This file

🚀 Quick Start

Get started with MintMule in minutes:

Prerequisites

  • Sui CLI installed
  • Sui wallet configured
  • Node.js 18+ and pnpm

Setup

# Clone the repository
git clone https://github.com/icekidtech/simple_nft.git
cd simple_nft

# Install dependencies
pnpm install

# Start development server
pnpm run dev

Visit http://localhost:5173 to access MintMule!

For detailed setup instructions, see our Getting Started Guide.

🎯 What is MintMule?

MintMule serves as a launchpad where:

  • For Creators: Deploy your NFT collections and manage your digital assets
  • For Collectors: Discover, mint, and collect unique NFTs from various creators
  • For Everyone: Experience the future of digital ownership on Sui

Key Benefits

  • Low Fees - Minimal gas costs thanks to Sui's efficiency
  • Fast Transactions - Near-instant finality
  • Secure Storage - Decentralized, tamper-proof asset ownership
  • Creator Friendly - Tools and features designed for content creators
  • Community Driven - Built by the community, for the community

📖 Documentation

Dive deep into MintMule's capabilities:

Document Description
Getting Started Complete setup and installation guide
Smart Contract Technical details of the NFT contract
Usage Guide Examples and API reference
Deployment Deploying to Sui networks
Testing Testing strategy and examples
Configuration Configuration options and settings
Troubleshooting Common issues and solutions
Architecture Design decisions and rationale

🛠 Development

Build the Smart Contract

sui move build

Run Tests

sui move test

Deploy to Devnet

./deploy.sh

Frontend Development

cd frontend
pnpm install
pnpm run dev

🌐 Networks

MintMule is available on multiple Sui networks:

  • Devnet - For development and testing
  • Testnet - Pre-production environment
  • Mainnet - Production environment

🤝 Contributing

We welcome contributions! See our Contributing Guide for details.

Ways to Contribute

  • 🐛 Report bugs and issues
  • 💡 Suggest new features
  • 📝 Improve documentation
  • 🔧 Submit code improvements
  • 🎨 Design enhancements

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

Need help? Here are your options:

🏗 Built With

  • Frontend: React, TypeScript, Tailwind CSS
  • Backend: Sui Move smart contracts
  • Wallet Integration: Sui dApp Kit
  • Deployment: Automated scripts for all networks

🎯 Roadmap

Phase 1 (Current)

  • ✅ Core NFT minting functionality
  • ✅ Basic creator tools
  • ✅ Web interface
  • ✅ Multi-network support

Phase 2 (Upcoming)

  • 🔄 Advanced creator dashboard
  • 🔄 Collection management
  • 🔄 Marketplace integration
  • 🔄 Social features

Phase 3 (Future)

  • 🔄 Cross-chain functionality
  • 🔄 Advanced analytics
  • 🔄 Mobile app
  • 🔄 Creator royalties

📊 Statistics

  • Transactions: 1000+ successful mints
  • Users: 500+ active users
  • Networks: 3 Sui networks supported
  • Uptime: 99.9% service availability

🙏 Acknowledgments

  • Sui Foundation for the amazing blockchain infrastructure
  • The Sui developer community for continuous support
  • All contributors and early adopters

🚀 Ready to start your NFT journey? Get Started Now!

Built with ❤️ on Sui for the decentralized future

About

Simple NFT made with Sui Move.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages