Skip to main content

Mobile App Installation

This guide provides a professional, step-by-step walkthrough to get the Quizix mobile application running on your local machine. This is an Expo-managed React Native project, ensuring a streamlined development experience.

📋 Before You Start​

Ensure your development environment meets the following requirements to avoid build errors.

✅ System Requirements​

RequirementMinimumRecommended
Node.jsv18.xv22.x (LTS)
Bunv1.xv1.1+ (Fastest)
Java (JDK)v17v17
Android SDKAPI 33+API 34+
macOS (iOS)VenturaSonoma + Xcode 15
Pro Tip

We recommend using Bun for significantly faster dependency installation and local development.

🔑 Step 1: Extract & Prepare​

After downloading the package from CodeCanyon, locate the mobile-app.zip and extract it to your preferred workspace.

# Navigate to the extracted project
cd mobile-app

📦 Step 2: Install Dependencies​

Choose your preferred package manager to install the required libraries.

bun install

⚙️ Step 3: Environment Setup​

Create your local environment file by copying the template and updating the API connection details.

  1. Create the .env file:

    cp .env.example .env

  2. Open .env and configure your API URL:

    # Your Admin Panel URL (Without trailing slash)
    EXPO_PUBLIC_API_BASE_URL=https://app.yourquizsite.com

    # Shared Mobile API Key
    EXPO_PUBLIC_MOBILE_APP_KEY=1234567890
Important

If testing on a physical device or Android Emulator, use your local IP address (e.g., http://192.168.1.100:8000) instead of localhost.

📱 Step 4: Native Build & Run​

Since Quizix uses native modules for Firebase and Stripe, use the following commands to build and launch the app.

Running on Android​

Ensure your Android Emulator is open or a physical device is connected via USB.

# Using Expo CLI
npx expo run:android

# OR via npm script
npm run android

Running on iOS (macOS Only)​

Ensure the iOS Simulator is selected and ready.

# Using Expo CLI
npx expo run:ios

# OR via npm script
npm run ios

🛠️ Troubleshooting Checklist​

If you encounter issues during installation, check the following:

  • Node Version: Check with node -v (Should be 18+).
  • Android SDK: Ensure ANDROID_HOME is set in your system environment.
  • Firebase Files: Ensure google-services.json and GoogleService-Info.plist are in the root directory.
  • Port Conflict: If port 8081 is busy, run npx expo start --port 8082.
  • Clean Cached Build: Run npx expo start -c to reset the bundler cache.

🏁 Conclusion​

Congratulations! Your Quizix mobile app should now be running. Proceed to the Configuration Guide to customize the branding, notifications, and payments.