feat: Add local network server for cross-device link management (#133)

* Initial plan

* Add local network server infrastructure

Co-authored-by: yogeshpaliyal <[email protected]>

* Update documentation for local network server feature

Co-authored-by: yogeshpaliyal <[email protected]>

* feat: add initial HTML interface for Deepr Link Manager

* feat: implement tag management and filtering for links

* feat: add ServerStatusBar component and integrate with navigation

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: yogeshpaliyal <[email protected]>
Co-authored-by: Yogesh Choudhary Paliyal <[email protected]>

Author: Copilot

README.md

@@ -21,6 +21,28 @@
 - Organize links by tags
 - Save link by sharing from other app (eg: chrome, etc.)
 - Save links to markdown file in local storage. (can be used for obsidian)
+- **Local network server:** Access and manage links from other devices on the same network
+
+### 🌐 Local Network Server
+
+The local network server feature allows you to access and manage your links from other devices on the same network. This is useful for:
+- Adding links from your desktop browser to your mobile device
+- Viewing your saved links on a bigger screen
+- Integrating with automation tools and scripts
+
+**Usage:**
+1. Open the app and go to Settings
+2. Tap on "Local Network Server"
+3. Toggle the server switch to start it
+4. Use the displayed URL or scan the QR code from another device
+5. Access the web interface or use the REST API
+
+**API Endpoints:**
+- `GET /api/links` - Get all saved links
+- `POST /api/links` - Add a new link (JSON body: `{"link": "url", "name": "name"}`)
+- `GET /api/link-info?url=<url>` - Get metadata for a URL
+
+**Note:** Both devices must be on the same Wi-Fi network.
 
 ## 🏗️ Tech Stack
 
@@ -32,6 +54,7 @@ The application is built using modern Android development practices and librarie
 - **Database:** SQLDelight
 - **Dependency Injection:** Koin
 - **Asynchronous Operations:** Kotlin Coroutines
+- **HTTP Client & Server:** Ktor
 
 ## 📲 Download
 You can download from any of the sources mentioned below.  

app/build.gradle.kts

@@ -2,6 +2,7 @@ plugins {
     alias(libs.plugins.android.application)
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.kotlin.compose)
+    alias(libs.plugins.kotlin.serialization)
     alias(libs.plugins.sqldelight)
     id("org.jmailen.kotlinter")
 }
@@ -115,6 +116,10 @@ dependencies {
     implementation(libs.jsoup)
     implementation(libs.ktor.client.core)
     implementation(libs.ktor.client.cio)
+    implementation(libs.ktor.server.core)
+    implementation(libs.ktor.server.cio)
+    implementation(libs.ktor.server.content.negotiation)
+    implementation(libs.ktor.serialization.kotlinx.json)
     implementation(libs.coil.compose)
     implementation(libs.coil.network.ktor3)
     implementation(libs.ktor.client.android)

app/src/main/AndroidManifest.xml

@@ -18,6 +18,8 @@
 
 
     <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 
     <application
         android:name=".DeeprApplication"

app/src/main/assets/index.html

@@ -12,9 +12,12 @@ import com.yogeshpaliyal.deepr.backup.ImportRepositoryImpl
 import com.yogeshpaliyal.deepr.data.HtmlParser
 import com.yogeshpaliyal.deepr.data.NetworkRepository
 import com.yogeshpaliyal.deepr.preference.AppPreferenceDataStore
+import com.yogeshpaliyal.deepr.server.LocalServerRepository
+import com.yogeshpaliyal.deepr.server.LocalServerRepositoryImpl
 import com.yogeshpaliyal.deepr.sync.SyncRepository
 import com.yogeshpaliyal.deepr.sync.SyncRepositoryImpl
 import com.yogeshpaliyal.deepr.viewmodel.AccountViewModel
+import com.yogeshpaliyal.deepr.viewmodel.LocalServerViewModel
 import io.ktor.client.HttpClient
 import io.ktor.client.engine.cio.CIO
 import org.koin.android.ext.koin.androidContext
@@ -74,6 +77,14 @@ class DeeprApplication : Application() {
                 single {
                     NetworkRepository(get(), get())
                 }
+
+                single<LocalServerRepository> {
+                    LocalServerRepositoryImpl(androidContext(), get(), get(), get())
+                }
+
+                viewModel {
+                    LocalServerViewModel(get())
+                }
             }
 
         startKoin {

app/src/main/java/com/yogeshpaliyal/deepr/DeeprApplication.kt

@@ -6,6 +6,7 @@ import android.os.Bundle
 import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
 import androidx.activity.enableEdgeToEdge
+import androidx.compose.foundation.layout.Column
 import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.material3.Surface
 import androidx.compose.material3.Text
@@ -23,17 +24,17 @@ import androidx.navigation3.ui.rememberSceneSetupNavEntryDecorator
 import com.yogeshpaliyal.deepr.preference.AppPreferenceDataStore
 import com.yogeshpaliyal.deepr.ui.screens.AboutUs
 import com.yogeshpaliyal.deepr.ui.screens.AboutUsScreen
+import com.yogeshpaliyal.deepr.ui.screens.LocalNetworkServer
+import com.yogeshpaliyal.deepr.ui.screens.LocalNetworkServerScreen
 import com.yogeshpaliyal.deepr.ui.screens.Settings
 import com.yogeshpaliyal.deepr.ui.screens.SettingsScreen
 import com.yogeshpaliyal.deepr.ui.screens.home.Home
 import com.yogeshpaliyal.deepr.ui.screens.home.HomeScreen
 import com.yogeshpaliyal.deepr.ui.theme.DeeprTheme
 import com.yogeshpaliyal.deepr.util.LanguageUtil
-import com.yogeshpaliyal.deepr.viewmodel.AccountViewModel
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.runBlocking
-import org.koin.androidx.viewmodel.ext.android.viewModel
 
 data class SharedLink(
     val url: String,
@@ -42,7 +43,6 @@ data class SharedLink(
 
 class MainActivity : ComponentActivity() {
     val sharingLink = MutableStateFlow<SharedLink?>(null)
-    private val accountViewModel: AccountViewModel by viewModel()
 
     override fun attachBaseContext(newBase: Context?) {
         super.attachBaseContext(
@@ -58,7 +58,7 @@ class MainActivity : ComponentActivity() {
                     } else {
                         context
                     }
-                } catch (e: Exception) {
+                } catch (_: Exception) {
                     context
                 }
             },
@@ -121,41 +121,47 @@ fun Dashboard(
 ) {
     val backStack = remember(sharedText) { mutableStateListOf<Any>(Home) }
 
-    NavDisplay(
-        backStack = backStack,
-        modifier = modifier,
-        entryDecorators =
-            listOf(
-                // Add the default decorators for managing scenes and saving state
-                rememberSceneSetupNavEntryDecorator(),
-                rememberSavedStateNavEntryDecorator(),
-                // Then add the view model store decorator
-                rememberViewModelStoreNavEntryDecorator(),
-            ),
-        onBack = { backStack.removeLastOrNull() },
-        entryProvider = { key ->
-            when (key) {
-                is Home ->
-                    NavEntry(key) {
-                        HomeScreen(
-                            backStack,
-                            sharedText = sharedText,
-                            resetSharedText = resetSharedText,
-                        )
-                    }
+    Column(modifier = modifier) {
+        NavDisplay(
+            backStack = backStack,
+            entryDecorators =
+                listOf(
+                    // Add the default decorators for managing scenes and saving state
+                    rememberSceneSetupNavEntryDecorator(),
+                    rememberSavedStateNavEntryDecorator(),
+                    // Then add the view model store decorator
+                    rememberViewModelStoreNavEntryDecorator(),
+                ),
+            onBack = { backStack.removeLastOrNull() },
+            entryProvider = { key ->
+                when (key) {
+                    is Home ->
+                        NavEntry(key) {
+                            HomeScreen(
+                                backStack,
+                                sharedText = sharedText,
+                                resetSharedText = resetSharedText,
+                            )
+                        }
 
-                is Settings ->
-                    NavEntry(key) {
-                        SettingsScreen(backStack)
-                    }
+                    is Settings ->
+                        NavEntry(key) {
+                            SettingsScreen(backStack)
+                        }
 
-                is AboutUs ->
-                    NavEntry(key) {
-                        AboutUsScreen(backStack)
-                    }
+                    is AboutUs ->
+                        NavEntry(key) {
+                            AboutUsScreen(backStack)
+                        }
 
-                else -> NavEntry(Unit) { Text("Unknown route") }
-            }
-        },
-    )
+                    is LocalNetworkServer ->
+                        NavEntry(key) {
+                            LocalNetworkServerScreen(backStack)
+                        }
+
+                    else -> NavEntry(Unit) { Text("Unknown route") }
+                }
+            },
+        )
+    }
 }

app/src/main/java/com/yogeshpaliyal/deepr/MainActivity.kt

@@ -0,0 +1,12 @@
+package com.yogeshpaliyal.deepr.server
+
+import kotlinx.coroutines.flow.StateFlow
+
+interface LocalServerRepository {
+    val isRunning: StateFlow<Boolean>
+    val serverUrl: StateFlow<String?>
+
+    suspend fun startServer()
+
+    suspend fun stopServer()
+}