Getting Started

Getting Started

Prerequisites

Before installing Pebbl, ensure you have:

  • Android Device: Android 7.0 (API level 24) or higher

  • Microphone Access: Required for voice recording

  • Internet Connection: Needed for AI processing (Wi-Fi recommended)

  • Storage: Minimum 100MB free space (for Vosk model and data)

  • OpenRouter API Key: Required for AI features

Installation

Option 1: Build from Source

  1. Clone the Repository

    git clone https://github.com/yourusername/Pebbl_Study.git
cd Pebbl

  2. Open in Android Studio

    • Launch Android Studio (latest version recommended)

    • Select "Open an Existing Project"

    • Navigate to the cloned Pebbl directory

  3. Sync Gradle Dependencies

    ./gradlew build

  4. Configure API Key (See Configuration section)

  5. Run on Device or Emulator

    • Connect Android device via USB (with USB debugging enabled)

    • Or launch Android Emulator

    • Click "Run" (Shift+F10)

Option 2: Install APK

  1. Download the latest APK from releases

  2. Enable "Install from Unknown Sources" in device settings

  3. Install the APK

  4. Configure API key on first launch

Configuration

Setting Up OpenRouter API Key

Pebbl requires an OpenRouter API key to access AI models for generating questions, drafts, and lecture analysis.

  1. Obtain API Key

    • Visit OpenRouter.ai

    • Sign up for an account

    • Navigate to API Keys section

    • Generate a new API key

  2. Add to local.properties

    Create or edit local.properties in the project root:

    ⚠️ Important: Never commit local.properties to version control. This file is already in .gitignore.

  3. Verify Configuration

    The API key is automatically loaded during build and made available via BuildConfig.OPENROUTER_API_KEY.

Vosk Model Setup

The app includes the Vosk speech recognition model (vosk-model-small-en-us-0.15, ~40MB) in the assets folder. On first launch:

  1. The model is automatically extracted to app storage

  2. If extraction fails, the app will download it to the files directory

  3. You can manually place the model in: /data/data/com.fouwaz.Pebbl/files/vosk-model-small-en-us-0.15/

First Run

  1. Launch Pebbl

  2. Grant Permissions: Allow microphone access when prompted

  3. You'll see the Project List screen (empty on first run)

  4. Create your first project by tapping the "+" button

  5. Start exploring!

PreviousIntroductionNextCore Features

Last updated