Polkadot API Playground

A developer-friendly interactive learning environment for exploring the Polkadot API. This playground allows you to experiment with various Polkadot-API operations using real testnet connections without the complexity of setting up a local development environment.

🚀 Features

Live Code Execution: Write, edit, and run Polkadot-API code directly in your browser
Pre-built Examples: Learn from curated examples covering common blockchain operations
Multiple Test Networks: Connect to Polkadot, Westend, and Paseo testnets
Well-known Test Accounts: Use Alice, Bob, and other test accounts with pre-funded balances
Console Output: View simulated execution results with detailed console output
Responsive Design: Use on desktop or mobile devices

🧰 Examples Included

Query account balances
Make token transfers
Watch finalized blocks
Subscribe to chain events
Interact with pallets
And more...

🧩 Technology Stack

Next.js 14: React framework with App Router
TypeScript: Type-safe JavaScript for better developer experience
Polkadot-API: Modern JavaScript/TypeScript library for Polkadot interaction
Tailwind CSS: Utility-first CSS framework for styling

🏁 Getting Started

Prerequisites

Node.js 18+ (LTS recommended)
npm, yarn, or pnpm

Installation

# Clone the repository
git clone https://github.com/developerfred/papi-simulator.git
cd papi-simulator

# Install dependencies
npm install
# or
yarn install
# or
pnpm install

# Start development server
npm run dev
# or
yarn dev
# or
pnpm dev

Then open http://localhost:3000 in your browser to see the playground.

👨‍💻 Usage

Select a network (Westend, Paseo or Polkadot)
Choose an example from the dropdown menu
Edit the code in the editor if desired
Click "Run Code" to execute
View the output in the console panel

💬 Community Engagement

We actively participate in the Polkadot ecosystem by:

Grant Applications

Polkadot Fast Grants Program - Our application to receive funding for continued development and expansion of the playground features.

Forum Discussions

Introducing PAPI Interactive Console/Playground - Join our discussion on the Polkadot Forum about the playground and share your feedback.

Development Tracking

Check our GitHub Issues to see what we're working on, report bugs, or suggest new features.

📚 Learning Resources

To learn more about Polkadot-API, check these resources:

🤝 Contributing

Contributions are welcome! Here are some ways you can contribute:

For Developers

Add new examples following our Community Template Guidelines
Improve existing examples
Fix bugs and enhance performance
Enhance the UI/UX
Add new features

For the Community

Share your use cases and example ideas
Report bugs and suggest improvements
Help with documentation and tutorials
Spread the word about the playground

Please feel free to submit a Pull Request.

📄 License

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

🙏 Acknowledgements

Polkadot and Parity Technologies for creating the Polkadot ecosystem
Polkadot-API Team for developing the API library
All contributors who have helped make this project better

Built with ❤️ for the Polkadot ecosystem