Backend Setup

Threadly requires a backend server for authentication, data storage, and real-time messaging. This guide shows you how to set up and configure the backend connection.

Backend Repository

Threadly’s backend is hosted in a separate repository:

Threadly Server

Node.js + Express + MySQL backend with Socket.IO support

Backend Stack

Runtime: Node.js
Framework: Express.js
Database: MySQL
Real-time: Socket.IO
Push Notifications: Firebase Cloud Messaging (FCM)

Configuration Options

You have two options for backend configuration:

Option 1: Use Hosted Backend
Option 2: Local Development

Use the Hosted Instance

The easiest way to get started is using the pre-configured hosted backend:

API URL: https://threadlyserver.onrender.com/api
Socket URL: https://threadlyserver.onrender.com/

The debug build variant is pre-configured with these URLs. No changes needed!

The hosted backend may have usage limits or slower response times. For production use, deploy your own instance.

Set Up Local Backend

For full control and faster development:

Clone the backend repository

git clone https://github.com/rashidekbal/threadlyServer.git
cd threadlyServer

Install dependencies

npm install

Configure environment

Create a .env file with your MySQL and Firebase credentials:

.env

DB_HOST=localhost
DB_USER=your_mysql_user
DB_PASSWORD=your_mysql_password
DB_NAME=threadly
PORT=8001

Start the server

npm start

The server should start on http://localhost:8001

Use a tool like ngrok or DevTunnels to expose your local server to your Android device.

Update Endpoint Configuration

To point Threadly to your own backend instance, update the build configuration:

Open app/build.gradle

Navigate to app/build.gradle in your Android Studio project.

Locate buildTypes section

Find the buildTypes block with debug and release configurations:

app/build.gradle

buildTypes {
    debug {
        buildConfigField "String", "BASE_URL",  "\"https://threadlyserver.onrender.com/api\""
        buildConfigField "String", "SOCKET_URL",  "\"https://threadlyserver.onrender.com/\""
    }
    release {
        buildConfigField "String", "BASE_URL",   "\"https://threadlyserver.onrender.com/api\""
        minifyEnabled false
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}

Update the URLs

Replace the URLs with your backend endpoints:

buildTypes {
    debug {
        buildConfigField "String", "BASE_URL",  "\"http://10.0.2.2:8001/api\""
        buildConfigField "String", "SOCKET_URL",  "\"http://10.0.2.2:8001/\""
    }
}

Use 10.0.2.2 for Android emulator to access localhost on your machine
For physical devices, use your machine’s local IP address (e.g., 192.168.1.x)
Always include /api suffix for BASE_URL
Always include trailing / for SOCKET_URL

Sync Gradle

Click Sync Now in the notification bar, or:

Windows/Linux: Ctrl + Shift + O
macOS: Cmd + Shift + O

Rebuild the app

Click Build > Rebuild Project to apply the new configuration.

Accessing BuildConfig Values

The configured URLs are available throughout your app via BuildConfig:

Java

import com.rtech.threadly.BuildConfig;

public class ApiService {
    private static final String BASE_URL = BuildConfig.BASE_URL;
    private static final String SOCKET_URL = BuildConfig.SOCKET_URL;
    
    // Use these constants in your API calls
}

Verify Backend Connection

After configuration, verify the connection:

Run the app

Launch Threadly on your device or emulator.

Check Logcat

Open Logcat in Android Studio and filter for network requests:

tag:OkHttp OR tag:Socket.IO

Test authentication

Try to log in or sign up. Successful requests indicate proper backend connectivity.

Connected successfully? You’re ready to use all of Threadly’s features.

Troubleshooting

Connection timeout / Network error

Verify backend server is running
Check firewall settings
Ensure URLs are correctly formatted (no typos)
For local development, confirm your device can reach the server

404 Not Found errors

Verify BASE_URL ends with /api
Check backend routes are properly configured
Confirm backend database is set up correctly

Socket.IO not connecting

Ensure SOCKET_URL has trailing /
Check CORS settings on backend
Verify Socket.IO server is running on the correct port
Check Logcat for Socket.IO connection events

Different URLs for debug/release

Update both debug and release build types separately:

buildTypes {
    debug {
        buildConfigField "String", "BASE_URL", "\"https://dev.api.com/api\""
    }
    release {
        buildConfigField "String", "BASE_URL", "\"https://api.com/api\""
    }
}

Environment-Specific Configuration

For team development, consider creating product flavors for different environments:

android {
    flavorDimensions "environment"
    productFlavors {
        dev {
            dimension "environment"
            buildConfigField "String", "BASE_URL", "\"https://dev-api.com/api\""
        }
        staging {
            dimension "environment"
            buildConfigField "String", "BASE_URL", "\"https://staging-api.com/api\""
        }
        prod {
            dimension "environment"
            buildConfigField "String", "BASE_URL", "\"https://api.com/api\""
        }
    }
}

Next Steps

Firebase Setup

Configure push notifications for real-time message delivery

Overview

Getting Started

Core Features

Architecture

Development

Backend Repository

Threadly Server

Backend Stack

Configuration Options

Use the Hosted Instance

Set Up Local Backend

Update Endpoint Configuration

Accessing BuildConfig Values

Verify Backend Connection

Troubleshooting

Environment-Specific Configuration

Next Steps

Firebase Setup

Build docs developers (and LLMs) love

Overview

Getting Started

Core Features

Architecture

Development

​Backend Repository

Threadly Server

​Backend Stack

​Configuration Options

​Use the Hosted Instance

​Set Up Local Backend

​Update Endpoint Configuration

​Accessing BuildConfig Values

​Verify Backend Connection

​Troubleshooting

​Environment-Specific Configuration

​Next Steps

Firebase Setup

Build docs developers (and LLMs) love

Backend Repository

Backend Stack

Configuration Options

Use the Hosted Instance

Set Up Local Backend

Update Endpoint Configuration

Accessing BuildConfig Values

Verify Backend Connection

Troubleshooting

Environment-Specific Configuration

Next Steps