Skip to content

Commit

Permalink
Merge pull request #7 from GerardPaligot/feat/m3
Browse files Browse the repository at this point in the history
Create artifact dedicated for m3 Design System
  • Loading branch information
martinbonnin authored Dec 19, 2022
2 parents 60303e2 + a881c2b commit 6c3d2d5
Show file tree
Hide file tree
Showing 61 changed files with 1,143 additions and 739 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ An Android client for Open-Feeedback https://github.com/HugoGresse/open-feedback

## Usage

The Composable `SessionFeedbackContainer` is the entry point to vote on a session. It'll make calls
The Composable `OpenFeedback` is the entry point to vote on a session. It'll make calls
between the Firebase which host your OpenFeedback instance and your mobile application. It is
mandatory to pass the `OpenFeedbackState` to give the Firebase configuration and your open-feedback
configuration which is common for all sessions of your event.

```kotlin
val openFeedbackState = rememberOpenFeedbackState(
// In your Application class
val config = OpenFeedbackConfig(
context = context,
projectId = "<your-open-feedback-project-id>",
firebaseConfig = OpenFeedback.FirebaseConfig(
projectId = "<your-firebase-open-feedback-project-id>",
Expand All @@ -22,8 +24,10 @@ val openFeedbackState = rememberOpenFeedbackState(
databaseUrl = "https://<your-firebase-open-feedback-project-id>.firebaseio.com"
)
)

// In your Compose screen
OpenFeedback(
openFeedbackState = openFeedbackState,
openFeedbackState = MyApp.config,
sessionId = "<your-open-feedback-session-id>",
language = "<language-code>"
)
Expand All @@ -37,13 +41,16 @@ If you want to see an example, please check the [sample-app](sample-app/src/main

The SDK is available on mavenCentral:

```
```kotlin
repositories {
mavenCentral()
}

dependencies {
implementation("io.openfeedback:feedback-android-sdk-ui:0.0.6")
// Material 2
implementation("io.openfeedback:feedback-android-sdk-m2:0.0.6")
// Material 3
implementation("io.openfeedback:feedback-android-sdk-m3:0.0.6")
}
```

Expand Down
26 changes: 11 additions & 15 deletions build-logic/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
plugins {
`embedded-kotlin`
`kotlin-dsl`
`java-gradle-plugin`
}

Expand All @@ -16,22 +17,17 @@ dependencies {

gradlePlugin {
plugins {
create("io.openfeedback.build.lib") {
id = "io.openfeedback.build.lib"
displayName = ""
description = ""
implementationClass = "io.openfeedback.build.LibraryPlugin"
register("io.openfeedback.plugins.lib") {
id = "io.openfeedback.plugins.lib"
implementationClass = "io.openfeedback.plugins.LibraryPlugin"
}
}
}

gradlePlugin {
plugins {
create("io.openfeedback.build.app") {
id = "io.openfeedback.build.app"
displayName = ""
description = ""
implementationClass = "io.openfeedback.build.AppPlugin"
register("io.openfeedback.plugins.compose.lib") {
id = "io.openfeedback.plugins.compose.lib"
implementationClass = "io.openfeedback.plugins.ComposeLibraryPlugin"
}
register("io.openfeedback.plugins.app") {
id = "io.openfeedback.plugins.app"
implementationClass = "io.openfeedback.plugins.AppPlugin"
}
}
}
Binary file removed build-logic/gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
5 changes: 0 additions & 5 deletions build-logic/gradle/wrapper/gradle-wrapper.properties

This file was deleted.

185 changes: 0 additions & 185 deletions build-logic/gradlew

This file was deleted.

89 changes: 0 additions & 89 deletions build-logic/gradlew.bat

This file was deleted.

1 change: 1 addition & 0 deletions build-logic/settings.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
enableFeaturePreview("VERSION_CATALOGS")
enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")

dependencyResolutionManagement {
versionCatalogs {
Expand Down
19 changes: 19 additions & 0 deletions build-logic/src/main/kotlin/io/openfeedback/EnvVarKeys.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package io.openfeedback

object EnvVarKeys {
object Nexus {
const val username = "SONATYPE_NEXUS_USERNAME"
const val password = "SONATYPE_NEXUS_PASSWORD"
const val profileId = "IO_OPENFEEDBACK_PROFILE_ID"
}

object GPG {
const val privateKey = "OPENFEEDBACK_GPG_PRIVATE_KEY"
const val password = "OPENFEEDBACK_GPG_PRIVATE_KEY_PASSWORD"
}

object GitHub {
const val event = "GITHUB_EVENT_NAME"
const val ref = "GITHUB_REF"
}
}
Loading

0 comments on commit 6c3d2d5

Please sign in to comment.