mini-apps

This is a repository containing all the mini-apps that are available through the mini-store.

🏪 Mini-Store: Submit Your Mini-App

Welcome to the Mini-Store! This is where developers can submit their mini-applications to be featured in our decentralized app store. Follow the guidelines below to get your mini-app reviewed and added to the store.

🚀 How to Submit Your Mini-App

1. Fork this repository
2. Add your mini-app data to src/data/appCatalog.ts
3. Add your assets to the appropriate folder in src/data/icons/
4. Submit a Pull Request
5. Wait for review (up to 72 hours)

📋 Submission Format

Your mini-app must follow this exact structure in the appCatalog.ts file:

App Object Structure

"your-app-id": {
  categories: ["Category1", "Category2"], // Required: Array of category strings
  publisherProfile: "0x...", // Required: Your Universal Profile address
  app: {
    profile: "0x...", // Required: Your Universal Profile address
    name: "Your App Name", // Required: Display name of your app
    url: "https://your-app-url.com", // Required: Direct link to your app
    sourceCode: "https://github.com/your-repo", // Optional: Link to source code
    defaultGridSize: {
      width: 1, // Required: Default width (1-2)
      height: 1 // Required: Default height (1-2)
    },
    previewImages: [ // Required: Array of screenshot URLs
      "screenshot1.src",
      "screenshot2.src"
    ]
  },
  // Legacy fields (required for compatibility)
  id: "your-app-id", // Required: Must match the key
  icon: "logo.src", // Required: Path to your app icon
  banner: "banner.src", // Optional: Path to banner image
  developer: "Your Company/Name", // Required: Developer name
  featured: false // Optional: Will be set by reviewers
}

🗂️ Required Assets

Create a folder in src/data/icons/your-app-id/ with these assets:

Required Files:

• logo.png or logo.webp - App icon (512x512px recommended)
• image_1.png - First screenshot
• image_2.png - Second screenshot (minimum)

Optional Files:

• banner.png or banner.jpg - Banner image (1200x400px recommended)
• image_3.png, image_4.png, etc. - Additional screenshots

Asset Guidelines:

• Use PNG for screenshots and logos with transparency
• Use JPG for banners and photos
• Keep file sizes under 2MB per image
• Use descriptive filenames
• Ensure images are high quality and professional

📱 Available Categories

Choose from these categories for your app:

• Art - Creative and artistic applications
• AI - Artificial Intelligence powered apps
• Brands - Brand and marketing applications
• Community - Community building tools
• DAOs - Decentralized Autonomous Organization tools
• DeFi - Decentralized Finance applications
• Exchanges - Trading and exchange platforms
• Fashion - Fashion and style applications
• Gaming - Games and gaming utilities
• Infrastructure - Development and infrastructure tools
• Marketplaces - Buying and selling platforms
• Music - Music and audio applications
• NFTs - Non-Fungible Token applications
• Security - Security and privacy tools
• Social - Social networking and communication
• Staking - Staking and validation tools

📝 Example Submission

Here's a complete example of how to add your app:

1. Add imports at the top of appCatalog.ts:

// Your App
import yourApp from "./icons/your-app-id/logo.png"
import yourAppBanner from "./icons/your-app-id/banner.jpg"
import yourAppScreenshot1 from "./icons/your-app-id/image_1.png"
import yourAppScreenshot2 from "./icons/your-app-id/image_2.png"

2. Add your app to the apps object:

"your-app-id": {
  categories: ["DeFi", "Social"],
  publisherProfile: "0x1234567890123456789012345678901234567890",
  app: {
    profile: "0x1234567890123456789012345678901234567890",
    name: "Your Amazing App",
    url: "https://your-amazing-app.com",
    sourceCode: "https://github.com/you/your-amazing-app",
    defaultGridSize: {
      width: 1,
      height: 2
    },
    previewImages: [
      yourAppScreenshot1.src,
      yourAppScreenshot2.src
    ]
  },
  id: "your-app-id",
  icon: yourApp.src,
  banner: yourAppBanner.src,
  developer: "Your Company",
  featured: false
},

✅ Submission Requirements

Before submitting, ensure your mini-app meets these requirements:

Technical Requirements:

• App is fully functional and accessible via the provided URL
• App works on both desktop and mobile devices
• App loads within 10 seconds on standard internet connections
• App has proper error handling and doesn't crash frequently

Content Requirements:

• App provides real value to users
• Content is appropriate and follows community guidelines
• App description is accurate and not misleading
• Screenshots represent actual app functionality

Submission Requirements:

• All required fields are filled out correctly
• Universal Profile address is valid and active
• All asset files are included and properly formatted
• App ID is unique and follows kebab-case naming
• Categories are appropriate for the app's functionality

🔍 Review Process

Timeline:

• Initial Review: Within 24 hours
• Technical Testing: 24-48 hours
• Final Approval: Up to 72 hours total

Review Criteria:

1. Functionality - App works as described
2. Quality - Professional appearance and user experience
3. Value - Provides genuine utility to users
4. Compliance - Follows all submission guidelines
5. Security - No malicious code or security vulnerabilities

Possible Outcomes:

• ✅ Approved - Your app will be merged and appear in the store
• 🔄 Needs Changes - Feedback provided for required modifications
• ❌ Rejected - App doesn't meet quality or guideline standards

📞 Support & Questions

• Issues: Open an issue in this repository
• Questions: Use the Discussions tab
• Urgent: Contact the maintainers directly

📜 Terms & Guidelines

By submitting your mini-app, you agree that:

• Your app is your original work or you have permission to distribute it
• The app doesn't contain malicious code or security vulnerabilities
• You will maintain the app and keep the URL functional
• You understand that inclusion in the store doesn't guarantee permanent placement
• The Mini-Store team reserves the right to remove apps that violate guidelines

🎯 Tips for Approval

1. Test thoroughly - Make sure your app works perfectly before submitting
2. High-quality assets - Use professional screenshots and icons
3. Clear description - Make sure your app name and category are accurate
4. Responsive design - Ensure your app works on all device sizes
5. Fast loading - Optimize your app for quick load times

---

Ready to submit? Fork this repo and add your mini-app today! 🚀