Home - alxspiker/Pi-Network-Developer-Docs GitHub Wiki
The complete guide to building robust applications on the Pi Network
Transform your ideas into powerful Pi Network applications with our comprehensive documentation, practical examples, and battle-tested best practices.
Transform your ideas into powerful Pi Network applications with our comprehensive documentation, practical examples, and battle-tested best practices.
🚀 Build once, run everywhere!
Create applications that provide exceptional experiences in both regular browsers (Web2) and Pi Browser (Web3) environments.
- Smart Pi Browser Detection - Automatically detect user environment
- Graceful Fallbacks - Seamless experience for all users
- Professional UX - No confusing popups or broken functionality
- Future-Proof Design - Ready for Pi Network's mainstream adoption
Choose your development path:
| 🔗 API Integration | ⚡ SDK Development | 🌐 Hybrid Apps |
| Connect to Pi Network APIs | Integrate Pi features directly | Build for Web2 + Web3 |
| 📖 API Reference | ⚡ SDK Reference | 🌐 Browser Detection |
📖 Core Documentation
- API Reference - Complete API endpoints and usage patterns
- SDK Reference - Pi App Platform SDK comprehensive guide
- Authorization - Authentication and security best practices
- Data Types - Object structures and data schemas
🛠️ Implementation Guides
- Pi Browser Detection - Build hybrid Web2/Web3 applications
- Payment Integration - Secure Pi transaction handling
- Migration Guide - Upgrade existing apps to hybrid architecture
- Code Examples - Working implementations and sample projects
🌟 Specialized Topics
- What is PiNet? - Cross-platform app accessibility
- What is PiWallet? - Pi Network wallet integration
- Mainnet vs Testnet - Environment selection guide
- Chat Rooms for Apps - Community features
💡 Pro Tip: Hybrid apps are the future of Pi Network development - they provide the best experience for all users while maximizing your app's reach.
| 🎯 Benefit | 📝 Description |
|---|---|
| 🌍 Broader Reach | Your app works seamlessly for both Web2 users and Pi Network pioneers |
| ✨ Better UX | No confusing authentication popups in regular browsers |
| 🛡️ Clean Experience | Graceful fallbacks with helpful guidance messaging |
| 🚀 Future-Ready | Prepared for Pi Network's mainstream adoption |
| 🔧 Easy Integration | Drop-in solutions for React and vanilla JavaScript |
🔍 Detection & Loading
- Smart Browser Detection
- Conditional Feature Loading
- Automatic Environment Recognition
👥 User Experience
- User-Initiated Authentication
- Professional Fallback Messages
- Production-Ready Error Handling
🎯 All examples include hybrid app support with Pi Browser detection
| 🚀 Project | 📝 Description | 🛠️ Technologies | 🔗 Link |
|---|---|---|---|
| Basic Login & Pay | Simple authentication and payments | JavaScript, Pi SDK | View → |
| Python Subscriptions | Flask backend with hybrid frontend | Python, Flask, JavaScript | View → |
| Full SDK Demo | Comprehensive Pi features showcase | React, Pi SDK | View → |
📋 Follow this comprehensive checklist to register, configure, and launch your Pi Network application
-
Download the Pi App:
-
Register for an account:
- Use a referral code. You can find them online.
-
Download and Sign into the Pi Browser:
-
Verify Email Address: (Required)
- Enter the Pi Mining App, click the ‘☰’ menu, and select "Profile".
-
Register your App and Configure Hosting:
- Enter App Name, Description, and select the Network (See our Pi Mainnet vs Testnet Page).
- Set up hosting on a third-party provider or Pi Network's Pi Engine.
-
Create a Wallet:
- Create a wallet at wallet.pi. Confirm access before continuing.
-
Code and Configure Your App
- Important: Use our updated Examples as a starting point, especially for hackathons.
- Hybrid App Architecture: Implement Pi Browser Detection for broader reach and better UX.
- Development URL: Enter the local host URL for sandbox testing.
-
Sandbox Mode:
- Set the sandbox flag to "true" in your FE code.
- Copy the sandbox code from the Pi Mining App utilities page.
-
Deploy and Validate
- Production URL: Enter your app's live URL.
-
Validate Domain Ownership: Add the provided key to a
validation-key.txtfile at your domain's root.
-
Test a Pi Transaction
- Process a User-to-App transaction to confirm everything is connected.
Prerequisites:
- Pi KYC Completion
- Mainnet Wallet
- Create a Mainnet Developer Portal Project
- Verify Mainnet App URL (Must be unique)
- Generate a New API Key (Testnet keys won't work)
- Launch and Test!
- Mainnet Payments: A migrated wallet is required on the user's end.
- Developer Terms of Service: Ensure your app stays compliant.