volyum-kmp-sdk
0.0.1-alpha04indexedIn-app user feedback SDK offering send, list (paged) and fetch-by-id APIs, with global or lifecycle-scoped instances, secure key guidance and ready demo UI components.
1
Stars
—
Used by
dependents
—
Health
/ 100
📣 Volyum
Volyum is a friendly feedback platform designed with Kotlin Multiplatform in mind. It helps developers easily gather valuable feedback from their users right within their app, using the Volyum SDK.
⚠️ Heads up: Volyum is still in active development. Thanks for checking it out early! Right now, the SDK requires private credentials, so it won’t work out of the box (unless you somehow already have them 👀).
Step 1: Installation
The Volyum SDK is available on Maven Central (the default store for Kotlin libraries), so installation is straightforward.
Add this dependency to your commonMain (for KMP) or your regular dependencies block:
dependencies {
implementation("io.github.donald-okara:volyum:$latest_version")
}
Step 2: Initialization
Volyum supports two integration styles, depending on whether you want a global singleton or a scoped instance tied to a lifecycle.
Option 1: 🔑 Global Setup (Singleton with VolyumSdk)
If you want one global Volyum instance available throughout your app, initialize it once at startup.
Android
class MyApp : Application() {
override fun onCreate() {
super.onCreate()
val config = VolyumConfig(
projectId = "your_project_id",
apiKey = "your_api_key"
)
VolyumSdk.init(config)
}
}
iOS (Compose Multiplatform)
fun MainViewController() = ComposeUIViewController {
// remember ensures config is stable across recompositions
val config = remember {
VolyumConfig("your_project_id", "your_api_key")
}
// Initialize SDK once
LaunchedEffect(Unit) {
VolyumSdk.init(config)
}
App()
}
Desktop
fun main() {
val config = VolyumConfig("your_project_id", "your_api_key")
VolyumSdk.init(config)
App() // launch Compose for Desktop
}
Access Volyum anywhere:
val volyum = VolyumSdk.get()
Option 2: 🏭 Scoped Setup (Lifecycle-aware with VolyumFactory)
If you want Volyum tied to a screen, feature, or DI scope, use VolyumFactory.
With Compose Multiplatform, you can rely on the multiplatform ViewModel.
Shared ViewModel (commonMain)
import androidx.lifecycle.ViewModel
import ke.don.volyum.feedback.config.*
class FeedbackViewModel : ViewModel() {
private val config = VolyumConfig("your_project_id", "your_api_key")
val volyum: Volyum = VolyumFactory.create(config)
}
Compose UI (Android, iOS, Desktop)
@Composable
fun FeedbackScreen(viewModel: FeedbackViewModel = viewModel()) {
val volyum = viewModel.volyum
// Use volyum safely here
}
👉 This works across all platforms supported by Compose Multiplatform.
⚖️ Which should I choose?
Use VolyumSdk.init (Global Singleton) if:
-
You want one shared instance across your entire app.
-
You don’t need per-feature configuration.
-
Your feedback system should behave consistently everywhere.
-
Best for small to medium apps or when feedback is a core global feature.
Use VolyumFactory (Scoped Instance) if:
-
You need separate instances for different screens/features.
-
You want to manage feedback lifecycles via DI or ViewModels.
-
You want to with different configurations easily.
Security note
- Do not hardcode real API keys in source control or binaries.
- Prefer injecting the key from secure config (BuildConfig on Android, plist/env on iOS, env vars/args on Desktop/CLI).
Step 3: Usage
The Volyum API has 3 main methods.
sendFeedback()
This is the method the app calls to send the feedback from the user.
/**
* Sends feedback to the Volyum API.
*
* @param feedback The feedback to send.
* @return A [VolyumResult] containing the sent feedback or a [NetworkError] if an error occurred.
*/
suspend fun sendFeedback(
feedback: Feedback,
): VolyumResult<Feedback, NetworkError> =
apiClient.addFeedback(feedback = feedback)
Sample usage
volyum.sendFeedback(
feedback = uiState.value.sendFeedback.copy(
userId = userData?.id,
targetType = uiState.value.targetType.label,
userMetadata = UserMetadata(
username = userData?.name,
profileUrl = userData?.profileUrl,
),
),
)
getFeedback()
This is the method that fetches the feedback list from the volyum api. Yes, it supports pagination by default
/**
* Retrieves a list of feedback entries based on the provided filter.
*
* This function makes an API call to fetch feedback. The results can be filtered * using the [GetFeedbackFilter] object. *
* @param filter The filter criteria to apply when fetching feedback.
* @return A [VolyumResult] which is either a [VolyumResult.Success] containing a list of [Feedback] objects * or a [VolyumResult.Error] containing a [NetworkError] if the request fails.
*/
suspend fun getFeedback(
filter: GetFeedbackFilter,
): VolyumResult<List<Feedback>, NetworkError> =
apiClient.getFeedback(filter)
Sample usage
volyum.getFeedback(
GetFeedbackFilter(
userId = userId,
status = FeedbackStatus.OPEN,
limit = 20,
offset = 0
)
getFeedbackById()
This method fetches a specific feedback item by id
/**
* Retrieves a feedback item by its unique identifier.
*
* This function makes an API call to fetch a specific feedback item based on the provided ID.
*
* @param id The unique identifier of the feedback to retrieve.
* @return A [VolyumResult] which is either a [VolyumResult.Success] containing the [Feedback] object
* or a [VolyumResult.Error] containing a [NetworkError] if the request fails.
*/
suspend fun getFeedbackById(
id: String,
): VolyumResult<Feedback, NetworkError> =
apiClient.getFeedbackById(id = id)
Sample usage
volyum.getFeedbackById(id)
📱 Demo
This is a demo of how Volyum works.
Desktop
Mobile
Documentation
Demo
The demo project i.e how to best utilize volyum is in the ComposeApp module along with all components I built. Feel free to repurpose for your app
The module's documentation will be found here
Library
The library is open source and we welcome contributors. All its documentation can be found here.