Skip to content

Repository files navigation

OrbidSwap Logo

OrbidSwap Mini App

The Native DEX for World App

License: MIT MiniKit World Chain

Open in World AppDocumentation


📱 Overview

This is the Mini App version of OrbidSwap, specifically optimized to run inside World App. It features a streamlined UI, native MiniKit integration, and simplified flows for mobile users.

Key Differences

Feature Web App Mini App
Environment Browser (Desktop/Mobile) World App (Mobile)
Connection WalletConnect / Injected MiniKit (Native)
Network World Chain Sepolia World Chain Mainnet
UI/UX Full Dashboard Touch-Optimized

✨ Features

  • 👆 One-Tap Connect: Seamless login with World App credentials.
  • ⚡ Fast Swaps: Optimized for mobile networks.
  • 🆔 Verified Access: Instant World ID verification.
  • 🎨 Native Feel: Adapts to World App's theme and navigation.

🛠️ Development

Prerequisites

  • Node.js 18+
  • World App Simulator (recommended)
  • Ngrok or similar tunneling service (for local dev testing in Simulator)

Installation

  1. Clone the repository

    git clone https://github.com/orbidorg/orbidswap-miniapp.git
    cd orbidswap-miniapp
  2. Install dependencies

    npm install
  3. Run Development Server

    npm run dev

Testing in World App Simulator

  1. Start your local server (npm run dev).
  2. Expose your localhost via ngrok: ngrok http 3000.
  3. Open the World App Developer Portal.
  4. Create a new app or edit existing one.
  5. Set the "Development URL" to your ngrok URL.
  6. Open the Simulator and scan the QR code.

📄 License

Distributed under the MIT License. See LICENSE for more information.


Built with ❤️ for the World Chain Ecosystem

Releases

Packages

Used by

Contributors

Languages