Skip to content

paraportxyz/docs

Repository files navigation

ParaPort Documentation

The embedded auto-teleport SDK bringing seamless cross-chain experiences to the Polkadot ecosystem.

ParaPort detects when users need assets on other parachains and automatically teleports funds before their primary action executes. Originally incubated inside KodaDot, ParaPort is evolving into a plug-and-play integration any parachain dApp can adopt.

Tip

Reach out at pulcondrej@gmail.com or explore the ParaPort repository for development updates.

✨ Key Capabilities

  • 🔄 Intent-Aware Auto-Teleport – Detect, route, and execute teleports before user actions fire
  • 🧠 ParaSpell Intelligence – Compose optimal XCM messages with fee buffers and recovery
  • 🗺️ Network Registry – Manage RPC endpoints, assets, and bridge adapters from a single config
  • 🎛️ Vue & React SDKs – Drop-in components and hooks with customizable UI states
  • 🛡️ Resilient Error Handling – Retries, partial teleport support, and user guidance for every failure mode
  • 📊 Observability Hooks – Emit metrics, logs, and lifecycle events for production monitoring

🚀 Quick Start

# Clone the documentation workspace
git clone https://github.com/paraportxyz/docs paraport-docs
cd paraport-docs

# Install dependencies
npm install

# Start the documentation server
npm run dev

The site runs at http://localhost:3000.

📁 Project Structure

paraport-docs/
├── content/              # Docus content files
│   ├── index.md          # Landing page
│   ├── 1.start-here/     # Quick-start material
│   ├── 2.basics/         # Team and philosophy
│   ├── 3.features/       # SDK + platform capabilities
│   └── 4.onboarding/     # Integration onboarding
├── public/               # Static assets
├── assets/               # Custom CSS and media
├── app.config.ts         # Site configuration
└── nuxt.config.ts        # Nuxt + Docus setup

🛠 Built With

🤝 Contributing

ParaPort documentation is a public-good resource. Improvements, tutorials, and translations are welcome!

# Production build
npm run build

# Preview the static output
npm run preview

Built files live in .output and can be deployed to any static host.

📬 Stay in Touch

📄 License

MIT License — ParaPort is built as shared infrastructure for the Polkadot ecosystem.