🚀Quick Start - 5 Minutes Setup
Get your crypto trading app running in just a few clicks!
1
Navigate to Setup
Go to setup/installers/ folder
2
Run Installer
Double-click the installer for your platform
3
Follow Wizard
Answer a few questions about your setup
4
Done!
Your app is ready to run
💻Choose Your Platform
Select the installer for your operating system. Note: iOS development requires macOS:
✅ What the Installer Does:
- Checks if Flutter, Dart, and Git are installed
- Guides you through app configuration (backend URL, app name, etc.)
- Sets up your custom app icon
- Installs all dependencies automatically
- Generates required code files
- Can build your app for release
⭐What You Get
📈 Spot Trading
Full order book and trading
⚡ Futures Trading
Leveraged trading platform
🤝 P2P Marketplace
Peer-to-peer trading
💰 Staking
Earn rewards on holdings
🚀 ICO Platform
Token launch platform
📱 Multi-Platform
Android, iOS, and Web
🎨 Beautiful UI
Modern design with themes
⚙️ Easy Config
JSON-based configuration
📋System Requirements
Essential Requirements:
- Flutter SDK 3.0.0+
- Dart SDK 2.17.0+
- Git
- BiCrypto v5 Backend (sold separately)
For Android Development:
- Android Studio
- Android SDK (API 21+)
- Java Development Kit (JDK) 11+
For iOS Development:
- macOS 10.14+
- Xcode 13.0+
- CocoaPods
- Apple Developer Account
For Web Development:
- Chrome browser (for debugging)
- Modern web browser
- Web server for deployment
Important Note:
- iOS development requires macOS
- Linux is not supported for iOS builds
- Use macOS for full platform development
⚙️App Configuration
The installer will create a configuration file for you. Here's what you'll need:
Required Information:
- Backend URL: Your server's API endpoint (e.g., https://api.yourexchange.com)
- WebSocket URL: For real-time updates (e.g., wss://api.yourexchange.com)
- App Name: What your app will be called
- Exchange Provider: Default exchange (Binance, KuCoin, OKX, etc.)
Optional Information:
- Stripe Publishable Key: For payment processing
- Google OAuth Client ID: For Google Sign-In
- Custom App Icon: Your own branding
Example Configuration:
{
"baseUrl": "https://api.yourexchange.com",
"wsBaseUrl": "wss://api.yourexchange.com",
"appName": "MyExchange",
"appVersion": "5.0.0",
"defaultExchangeProvider": "bin",
"defaultTradingPair": "BTC/USDT"
}
🛠️Manual Setup (Advanced)
If you prefer to set up manually or the installer fails:
# 1. Install Flutter (if not installed)
# Visit: https://flutter.dev/docs/get-started/install
# 2. Copy configuration template
cp assets/config/app_config.example.json assets/config/app_config.json
# 3. Edit configuration with your settings
# Edit: assets/config/app_config.json
# 4. Install dependencies
flutter pub get
# 5. Generate code
flutter pub run build_runner build --delete-conflicting-outputs
# 6. Run the app
flutter run
📱Building for Production
Once your app is configured and tested, build it for distribution:
# Android APK
flutter build apk --release
# Android App Bundle (for Google Play Store)
flutter build appbundle --release
# iOS (requires macOS and Xcode)
flutter build ios --release
# Web
flutter build web
⚠️ Important for iOS:
iOS builds require macOS and Xcode. You'll also need to configure code signing with your Apple Developer account.
🔧Troubleshooting
Common Issues & Solutions:
❌ "Configuration Error" on app start:
- Ensure
assets/config/app_config.json exists
- Check JSON syntax (no trailing commas)
- Verify URLs include https:// or wss://
❌ "Flutter not found" error:
- Make sure Flutter is in your system PATH
- Restart terminal/command prompt
- Run
flutter doctor to check setup
❌ Build failures:
- Run
flutter clean then flutter pub get
- Delete generated files and regenerate
- Check Android SDK setup
❌ Connection issues:
- Verify your backend is running
- Check CORS settings for web platform
- Test API endpoints manually
📚Additional Documentation
For detailed information, check these files in your project:
- setup/docs/README_CODECANYON.md - Complete overview
- setup/docs/INSTALLATION_GUIDE.md - Detailed installation
- setup/docs/CONFIGURATION_GUIDE.md - Configuration reference
- setup/docs/APP_ICON_GUIDE.md - Icon customization
- setup/docs/APP_NAME_CONFIGURATION.md - App naming guide
- assets/config/CONFIG_FIELDS_EXPLAINED.md - All config options
- assets/config/QUICK_REFERENCE.txt - Quick value lookup
🆘Need Help?
Before requesting support:
- Try the automated installer first
- Check all documentation files
- Run
flutter doctor -v to check your setup
- Verify your backend is working
When requesting support, please provide:
- Your operating system
- Flutter doctor output
- Error messages/screenshots
- Steps to reproduce the issue