Core¶
Getting Started with Core¶
Adding Dependencies:
- Manual Setup: This section guides you through adding Core dependencies directly to your project's
build.gradle
files. (Link to Manual Dependency Setup Section) - Version Catalog (Recommended): For a more streamlined approach, consider integrating a version catalog. This allows for centralized version management and easier updates. (Link to Version Catalog Section)
Note: If you prefer manual dependency setup, follow the instructions in the "Manual Setup" section. Otherwise, jump to the "Version Catalog" section for centralized management.
For information on using the KAPT plugin, see the KAPT documentation.
For information on using the KSP plugin, see the KSP quick-start documentation.
For more information about dependencies, see Add Build Dependencies.
Adding Core Dependencies Manually¶
To use Core in your app, add the following dependencies to your app's build.gradle
file:
dependencies {
def teogorCeresCore = "1.0.0-alpha05"
implementation "dev.teogor.ceres:core-common:$teogorCeresCore"
implementation "dev.teogor.ceres:core-analytics:$teogorCeresCore"
implementation "dev.teogor.ceres:core-foundation:$teogorCeresCore"
implementation "dev.teogor.ceres:core-network:$teogorCeresCore"
implementation "dev.teogor.ceres:core-notifications:$teogorCeresCore"
implementation "dev.teogor.ceres:core-register:$teogorCeresCore"
implementation "dev.teogor.ceres:core-runtime:$teogorCeresCore"
implementation "dev.teogor.ceres:core-start-up:$teogorCeresCore"
}
dependencies {
val teogorCeresCore = "1.0.0-alpha05"
implementation("dev.teogor.ceres:core-common:$teogorCeresCore")
implementation("dev.teogor.ceres:core-analytics:$teogorCeresCore")
implementation("dev.teogor.ceres:core-foundation:$teogorCeresCore")
implementation("dev.teogor.ceres:core-network:$teogorCeresCore")
implementation("dev.teogor.ceres:core-notifications:$teogorCeresCore")
implementation("dev.teogor.ceres:core-register:$teogorCeresCore")
implementation("dev.teogor.ceres:core-runtime:$teogorCeresCore")
implementation("dev.teogor.ceres:core-start-up:$teogorCeresCore")
}
Managing Core Versions with Version Catalog (Recommended)¶
This section guides you through utilizing a version catalog for centralized management of Core dependencies in your project. This approach simplifies updates and ensures consistency.
First, define the dependencies in the libs.versions.toml
file:
- Group-Name Based: This approach is used for declaring libraries referenced by group and artifact name.
- Module Based: This approach is used for declaring libraries referenced by their module.
[versions]
teogor-ceres-core = "1.0.0-alpha05"
[libraries]
teogor-ceres-core-common = { group = "dev.teogor.ceres", name = "core-common", version.ref = "teogor-ceres-core" }
teogor-ceres-core-analytics = { group = "dev.teogor.ceres", name = "core-analytics", version.ref = "teogor-ceres-core" }
teogor-ceres-core-foundation = { group = "dev.teogor.ceres", name = "core-foundation", version.ref = "teogor-ceres-core" }
teogor-ceres-core-network = { group = "dev.teogor.ceres", name = "core-network", version.ref = "teogor-ceres-core" }
teogor-ceres-core-notifications = { group = "dev.teogor.ceres", name = "core-notifications", version.ref = "teogor-ceres-core" }
teogor-ceres-core-register = { group = "dev.teogor.ceres", name = "core-register", version.ref = "teogor-ceres-core" }
teogor-ceres-core-runtime = { group = "dev.teogor.ceres", name = "core-runtime", version.ref = "teogor-ceres-core" }
teogor-ceres-core-start-up = { group = "dev.teogor.ceres", name = "core-start-up", version.ref = "teogor-ceres-core" }
[versions]
teogor-ceres-core = "1.0.0-alpha05"
[libraries]
teogor-ceres-core-common = { module = "dev.teogor.ceres:core-common", version.ref = "teogor-ceres-core" }
teogor-ceres-core-analytics = { module = "dev.teogor.ceres:core-analytics", version.ref = "teogor-ceres-core" }
teogor-ceres-core-foundation = { module = "dev.teogor.ceres:core-foundation", version.ref = "teogor-ceres-core" }
teogor-ceres-core-network = { module = "dev.teogor.ceres:core-network", version.ref = "teogor-ceres-core" }
teogor-ceres-core-notifications = { module = "dev.teogor.ceres:core-notifications", version.ref = "teogor-ceres-core" }
teogor-ceres-core-register = { module = "dev.teogor.ceres:core-register", version.ref = "teogor-ceres-core" }
teogor-ceres-core-runtime = { module = "dev.teogor.ceres:core-runtime", version.ref = "teogor-ceres-core" }
teogor-ceres-core-start-up = { module = "dev.teogor.ceres:core-start-up", version.ref = "teogor-ceres-core" }
Then, add these dependencies in your app's build.gradle
file:
dependencies {
implementation libs.teogor.ceres.core.common
implementation libs.teogor.ceres.core.analytics
implementation libs.teogor.ceres.core.foundation
implementation libs.teogor.ceres.core.network
implementation libs.teogor.ceres.core.notifications
implementation libs.teogor.ceres.core.register
implementation libs.teogor.ceres.core.runtime
implementation libs.teogor.ceres.core.start.up
}
dependencies {
implementation(libs.teogor.ceres.core.common)
implementation(libs.teogor.ceres.core.analytics)
implementation(libs.teogor.ceres.core.foundation)
implementation(libs.teogor.ceres.core.network)
implementation(libs.teogor.ceres.core.notifications)
implementation(libs.teogor.ceres.core.register)
implementation(libs.teogor.ceres.core.runtime)
implementation(libs.teogor.ceres.core.start.up)
}