Merge branch 'v0.0.2'

# Conflicts:
#	README.md

Author: sakethpathike

README.md

@@ -47,10 +47,26 @@ will be prompted to provide the required values, which will be saved locally.
 ```
 
 - `databaseUrl`: The database URL (without username or password).
-- `databaseUser`: The username for your database.
-- `databasePassword`: The password for your database.
-- `hostAddress`: The host address of the server. If not provided, defaults to `0.0.0.0`.
-- `serverPort`: The port number on which the server runs. If not provided, defaults to `8080`.
+  - `databaseUrl` should always start with the name of the database you're using:
+    - PGSQL (or) PostgreSQL :
+      ```
+      postgresql://someAddress:port/linkora
+      ``` 
+    - MySQL :
+      ```
+      mysql://someAddress:port/linkora
+      ``` 
+    - SQLite :
+      ```
+      sqlite:path-to-db
+      ``` 
+      `path-to-db` should look something like `sqlite:/home/saketh/Documents/sqlite/databaseFileName`
+- `databaseUser`: The username of the database you want to connect to.
+  - If you are using SQLite, leave this blank or press Enter when the setup prompts for it.
+- `databasePassword`: The password of the database you want to connect to.
+  - If you are using SQLite, leave this blank or press Enter when the setup prompts for it.
+- `hostAddress`: The host address of the server. If not provided, it defaults to the `IPv4` of the network currently connected to. When connecting from Linkora apps, you should pass this address instead of `localhost`.
+- `serverPort`: The port number on which the server runs. If not provided, defaults to `45454`.
 - `serverAuthToken`: A secure token used to authenticate requests from the Linkora app. Treat this like a password and
   keep it confidential.
 
@@ -65,13 +81,15 @@ set:
 
 - `LINKORA_SERVER_USE_ENV_VAL`: Set this to `true` to enable the use of environment variables. This must always be `true` when using environment variables.
 - `LINKORA_DATABASE_URL`: The database URL (without username or password).
-- `LINKORA_DATABASE_USER`: The username for your database.
-- `LINKORA_DATABASE_PASSWORD`: The password for your database.
+- `LINKORA_DATABASE_USER`: The username of the database you want to connect to.
+  - If you are using SQLite, leave this blank.
+- `LINKORA_DATABASE_PASSWORD`: The password of the database you want to connect to.
+  - If you are using SQLite, leave this blank.
 - `LINKORA_SERVER_AUTH_TOKEN`: A secure token used to authenticate requests from the Linkora app. Treat this like a
   password and
   keep it confidential.
-- `LINKORA_HOST_ADDRESS`: The host address of the server. If not provided, defaults to `0.0.0.0`.
-- `LINKORA_SERVER_PORT`: The port number on which the server runs. If not provided, defaults to `8080`.
+- `LINKORA_HOST_ADDRESS`: The host address of the server. If not provided, it defaults to the `IPv4` of the network currently connected to. When connecting from Linkora apps, you should pass this address instead of `localhost`.
+- `LINKORA_SERVER_PORT`: The port number on which the server runs. If not provided, defaults to `45454`.
 
 ### 3. Hosting Options
 
@@ -178,6 +196,12 @@ systemctl start linkora.service
 systemctl enable linkora.service
 ```
 
+#### Workflow of Linkora, which should make it easier to understand how everything works:
+
+<a href="https://github.com/user-attachments/assets/bb2d9b7e-92c4-41ed-82d3-ad821cc65638" onclick="window.open(this.href, '_blank'); return false;">
+  <img alt="linkora-outline.png" src="https://github.com/user-attachments/assets/bb2d9b7e-92c4-41ed-82d3-ad821cc65638" style="max-width: 100%; height: auto;">
+</a>
+
 ### Join the Community
 
 [![Join us on Discord](https://discord.com/api/guilds/1214971383352664104/widget.png?style=banner2)](https://discord.gg/ZDBXNtv8MD)

src/main/kotlin/com/sakethh/linkora/Application.kt

@@ -15,6 +15,9 @@ import io.ktor.server.netty.*
 import io.ktor.server.websocket.*
 import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
+import java.awt.Desktop
+import java.net.InetAddress
+import java.net.URI
 import java.nio.file.Files
 import java.nio.file.Paths
 import java.nio.file.StandardOpenOption
@@ -89,11 +92,11 @@ object ServerConfiguration {
                     // manually throw the exception as `getenv` may return null, and no conversion is happening here to auto-throw
                     System.getenv(SysEnvKey.LINKORA_HOST_ADDRESS.name) ?: throw NullPointerException()
                 } catch (_: Exception) {
-                    "0.0.0.0"
+                    InetAddress.getLocalHost().hostAddress
                 }, serverPort = try {
                     System.getenv(SysEnvKey.LINKORA_SERVER_PORT.name).toInt()
                 } catch (_: Exception) {
-                    8080
+                    45454
                 },
                 serverAuthToken = System.getenv(SysEnvKey.LINKORA_SERVER_AUTH_TOKEN.name)
             )
@@ -128,11 +131,9 @@ fun Application.module() {
         maxFrameSize = Long.MAX_VALUE
     }
     configureEventsWebSocket()
-    val currentOS = System.getProperty("os.name").lowercase()
-    val serverConfiguredPage = serverConfig.hostAddress+ ":"+ serverConfig.serverPort + "/"+ SyncRoute.SERVER_IS_CONFIGURED.name
-    when {
-        currentOS.contains("win") -> Runtime.getRuntime().exec("rundll32 url.dll,FileProtocolHandler $serverConfiguredPage")
-        currentOS.contains("mac") -> Runtime.getRuntime().exec("open $serverConfiguredPage")
-        currentOS.contains("nix") || currentOS.contains("nux") -> Runtime.getRuntime().exec("xdg-open $serverConfiguredPage")
+    val serverConfiguredPage =
+        "http://" + serverConfig.hostAddress + ":" + serverConfig.serverPort + "/" + SyncRoute.SERVER_IS_CONFIGURED.name
+    if (Desktop.isDesktopSupported() && Desktop.getDesktop().isSupported(Desktop.Action.BROWSE)) {
+        Desktop.getDesktop().browse(URI(serverConfiguredPage))
     }
 }

src/main/kotlin/com/sakethh/linkora/Constants.kt

@@ -1,5 +1,5 @@
 package com.sakethh.linkora
 
 object Constants {
-    const val SERVER_VERSION = "0.0.1"
+    const val SERVER_VERSION = "0.0.2"
 }

src/main/kotlin/com/sakethh/linkora/data/repository/MarkdownManagerRepoImpl.kt

@@ -13,11 +13,22 @@ class MarkdownManagerRepoImpl : MarkdownManagerRepo {
     private val markdownFlavour = CommonMarkFlavourDescriptor()
     private val mdParser = MarkdownParser(markdownFlavour)
 
-    override fun getRawHtmlBasedOnMD(fileLocation: String, placeHolder: Pair<PlaceHolder, PlaceHolderValue>): String {
+    override fun getRawHtmlBasedOnMDFile(
+        fileLocation: String,
+        placeHolder: Pair<PlaceHolder, PlaceHolderValue>
+    ): String {
         val file = this::class.java.getResourceAsStream(fileLocation)
         val rawMDText = file.use { it?.bufferedReader()?.readText().toString() }
             .replace(placeHolder.first, placeHolder.second)
         val parseTree = mdParser.buildMarkdownTreeFromString(rawMDText)
         return HtmlGenerator(markdownText = rawMDText, parseTree, markdownFlavour).generateHtml()
     }
+
+    override fun getRawHtmlBasedOnRawMD(rawMD: String): String {
+        return HtmlGenerator(
+            markdownText = rawMD,
+            mdParser.buildMarkdownTreeFromString(rawMD),
+            markdownFlavour
+        ).generateHtml()
+    }
 }

src/main/kotlin/com/sakethh/linkora/domain/repository/MarkdownManagerRepo.kt

@@ -4,5 +4,6 @@ import com.sakethh.linkora.domain.PlaceHolder
 import com.sakethh.linkora.domain.PlaceHolderValue
 
 interface MarkdownManagerRepo {
-    fun getRawHtmlBasedOnMD(fileLocation: String, placeHolder: Pair<PlaceHolder, PlaceHolderValue>): String
+    fun getRawHtmlBasedOnMDFile(fileLocation: String, placeHolder: Pair<PlaceHolder, PlaceHolderValue>): String
+    fun getRawHtmlBasedOnRawMD(rawMD:String): String
 }

src/main/kotlin/com/sakethh/linkora/presentation/routing/Routing.kt

@@ -1,5 +1,6 @@
 package com.sakethh.linkora.presentation.routing
 
+import com.sakethh.linkora.Constants
 import com.sakethh.linkora.Security
 import com.sakethh.linkora.data.repository.FoldersImplementation
 import com.sakethh.linkora.data.repository.LinksImplementation
@@ -19,6 +20,7 @@ import io.ktor.server.application.*
 import io.ktor.server.auth.*
 import io.ktor.server.response.*
 import io.ktor.server.routing.*
+import org.jetbrains.exposed.sql.Database
 import java.net.InetAddress
 
 fun Application.configureRouting(serverConfig: ServerConfig, markdownManagerRepo: MarkdownManagerRepo) {
@@ -45,7 +47,7 @@ fun Application.configureRouting(serverConfig: ServerConfig, markdownManagerRepo
                 } else {
                     ""
                 }
-            val requiredHtml = markdownManagerRepo.getRawHtmlBasedOnMD(
+            val requiredHtml = markdownManagerRepo.getRawHtmlBasedOnRawMD("The sync-server version is **${Constants.SERVER_VERSION}**.\n\nYou are currently connected to the **${Database.getDialectName(serverConfig.databaseUrl)}** database, which will be **used by the server to store data**.")+markdownManagerRepo.getRawHtmlBasedOnMDFile(
                 fileLocation = "/raw/SERVER_IS_CONFIGURED.md", placeHolder = "#{PLACEHOLDER_1}" to placeHolderValue
             )
             call.respondText(contentType = ContentType.Text.Html, text = requiredHtml)

src/main/resources/raw/SERVER_IS_CONFIGURED.md

@@ -1,6 +1,4 @@
-It seems you've correctly configured the sync server.
-
-Before anything, check out this video where I explained how to connect the app and the server. That should clear up most things.
+It seems you've configured the sync-server correctly; to check if it's running, browse to this endpoint or refresh—if the page loads again, the server is up; ensure the connected database is also running.
 
 This server is meant to communicate only with the **[Linkora](https://github.com/LinkoraApp/Linkora)** apps, available on **Android** and **Desktop**. There's no web-based frontend yet, so you can’t control anything through a web interface. That said, if you’re willing to build your own custom solution from scratch that connects to this server and does what it needs to, then it’s totally possible.
 
@@ -37,7 +35,14 @@ This server is meant to communicate only with the **[Linkora](https://github.com
 - Except for this route, every other route is secured by an auth token. Access is only granted if the client provides the correct auth token that you’ve set. Without it, they won’t be able to access anything.
 
 ## Troubleshooting & Additional Help
-- If something isn’t covered here, check out the **YouTube video** where I explained how to connect the app and the server.
-- Also, go through **[GitHub issues](https://github.com/LinkoraApp/sync-server/issues)**; you might find the solution there.
+- Always go through the [README](https://github.com/LinkoraApp/sync-server/blob/master/README.md); it covers most of the info you're probably looking for.
+- If something isn’t covered here, go through **[GitHub issues](https://github.com/LinkoraApp/sync-server/issues)**; you might find the solution there.
 - If not, **[create an issue on GitHub](https://github.com/LinkoraApp/sync-server/issues/new)**, and I'll fix it when I get some time.
-- You can also [join the Discord](https://discord.gg/ZDBXNtv8MD) if you want. It’s there for questions, updates, or just to hang out.
+- You can also [join the Discord](https://discord.gg/ZDBXNtv8MD) if you want. It’s there for questions, updates, or just to hang out.
+
+---
+#### Workflow of Linkora, which should make it easier to understand how everything works:
+
+<a href="https://github.com/user-attachments/assets/bb2d9b7e-92c4-41ed-82d3-ad821cc65638" onclick="window.open(this.href, '_blank'); return false;">
+  <img alt="linkora-outline.png" src="https://github.com/user-attachments/assets/bb2d9b7e-92c4-41ed-82d3-ad821cc65638" style="max-width: 100%; height: auto;">
+</a>