Skip to main content
Follow these steps to get Threadly up and running on your local development machine.

Clone the Repository

1

Clone via HTTPS

Open your terminal and run:
git clone https://github.com/rashidekbal/threadly.git
2

Navigate to project directory

cd threadly
If you have SSH keys configured with GitHub:
git clone [email protected]:rashidekbal/threadly.git
cd threadly

Open in Android Studio

1

Launch Android Studio

Open Android Studio on your machine.
2

Open the project

  • Select File > Open from the menu
  • Navigate to the threadly directory you just cloned
  • Click OK to open the project
3

Wait for Gradle sync

Android Studio will automatically start syncing Gradle. This process:
  • Downloads project dependencies
  • Configures the build system
  • Indexes the project files
The first sync may take several minutes depending on your internet connection and machine specs.

Verify Project Configuration

After Gradle sync completes, verify your project setup:
android {
    namespace 'com.rtech.threadly'
    compileSdk 36
    
    defaultConfig {
        applicationId "com.rtech.threadly"
        minSdk 29
        targetSdk 36
        versionCode 1
        versionName "1.2"
    }
    
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_11
        targetCompatibility JavaVersion.VERSION_11
    }
}
Sync successful? Your project is ready for the next steps.

Configure Build Variants

Threadly comes with two build variants:

Debug Build

  • Pre-configured with hosted backend URLs
  • Suitable for development and testing
  • No additional configuration needed

Release Build

  • Optimized for production
  • Configure signing keys for distribution
For initial setup, use the debug build variant which is selected by default.

Build the Project

1

Select build variant

In Android Studio:
  • Open Build > Select Build Variant
  • Choose debug from the dropdown
2

Build the app

Click Build > Make Project or press:
  • Windows/Linux: Ctrl + F9
  • macOS: Cmd + F9
3

Wait for build to complete

Monitor the Build tab at the bottom of Android Studio for progress and any errors.

Run the App

1

Connect a device or start an emulator

  1. Enable Developer Options on your Android device
  2. Enable USB Debugging
  3. Connect via USB cable
  4. Verify device appears in Android Studio’s device dropdown
2

Run the app

Click the Run button (green play icon) or press:
  • Windows/Linux: Shift + F10
  • macOS: Control + R
3

Wait for app to launch

The app will:
  • Install on your device/emulator
  • Launch automatically
  • Display the splash screen
Before you can fully use the app, you need to configure the backend and Firebase. Continue to the next sections.

Troubleshooting

  1. Check your internet connection
  2. Try File > Invalidate Caches / Restart
  3. Verify JDK 11 is properly configured
  4. Check Android Studio’s error messages for specific issues
  • Ensure you have the latest Android SDK components installed
  • Verify compileSdk 36 is available in SDK Manager
  • Clean and rebuild: Build > Clean Project then Build > Rebuild Project
  • Verify you’ve completed Backend Setup
  • Check Logcat for error messages
  • Ensure device meets minimum SDK requirements (API 29+)

Next Steps

Backend Setup

Configure API and Socket.IO endpoints

Firebase Setup

Enable push notifications with FCM

Build docs developers (and LLMs) love