Skip to content

Commit

Permalink
rev
Browse files Browse the repository at this point in the history
  • Loading branch information
teogor committed Nov 8, 2023
1 parent 2a33415 commit c0b5c2c
Show file tree
Hide file tree
Showing 32 changed files with 7,971 additions and 675 deletions.
7,391 changes: 7,269 additions & 122 deletions .resources/bom/1.0.0-alpha01/dependencies-1.0.0-alpha01.json

Large diffs are not rendered by default.

10 changes: 8 additions & 2 deletions .resources/bom/versions.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[
{
"version": "1.0.0-alpha01",
"date": 1695925132
"version": {
"major": 1,
"minor": 0,
"patch": 0,
"flag": "Alpha",
"versionQualifier": 1
},
"date": 1699465547
}
]
2 changes: 1 addition & 1 deletion bom/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ winds {
major = 1,
minor = 0,
patch = 0,
).setAlphaRelease(4)
).setAlphaRelease(1)

defineBoM()
}
Expand Down
2 changes: 1 addition & 1 deletion core/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ winds {
major = 1,
minor = 0,
patch = 0,
).setAlphaRelease(3)
).setAlphaRelease(1)
}
}
2 changes: 1 addition & 1 deletion data/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ winds {
major = 1,
minor = 0,
patch = 0,
).setAlphaRelease(2)
).setAlphaRelease(1)
}
}
74 changes: 39 additions & 35 deletions docs/bom/1.0.0-alpha01/bom-version-1.0.0-alpha01.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,54 +8,58 @@ To learn which Ceres library versions are mapped to a specific BoM version, chec

Learn more about [Gradle's support for BoM platforms](https://docs.gradle.org/4.6-rc-1/userguide/managing_transitive_dependencies.html#sec:bom_import).

Here's how to use the Ceres Android BoM to declare dependencies in your module (app-level) Gradle file (usually app/build.gradle.kts). When using the BoM, you don't specify individual library versions in the dependency lines.
Here's how to use the Ceres BoM to declare dependencies in your module (app-level) Gradle file (usually app/build.gradle.kts). When using the BoM, you don't specify individual library versions in the dependency lines.

```kt
dependencies {
// Import the BoM for the Ceres platform
implementation(platform("dev.teogor.ceres:bom:1.0.0-alpha01"))

// Declare the dependencies for the desired Ceres products without specifying versions
// For example, declare the dependencies for Ceres Core Runtime and Ceres Core Network
implementation("dev.teogor.ceres:core-runtime")
implementation("dev.teogor.ceres:core-network")
// Declare the dependencies for the desired Ceres products
// without specifying versions. For example, declare:
// Ceres Screen Builder
implementation("dev.teogor.ceres:screen-builder")
// Ceres Framework Core
implementation("dev.teogor.ceres:framework-core")
// Ceres Monetisation AdMob
implementation("dev.teogor.ceres:monetisation-admob")
}
```

## Latest SDK versions

| Status | Service or Product | Gradle dependency | Latest version |
| ------ | ------------------ | ----------------- | -------------- |
| 🧪 | [Ceres Backup Core](/backup/core) | dev.teogor.ceres:backup-core | 1.0.0-alpha01 |
| 🧪 | [Ceres Backup UI](/backup/ui) | dev.teogor.ceres:backup-ui | 1.0.0-alpha01 |
| 🧪 | [Ceres Core Network](/core/network) | dev.teogor.ceres:core-network | 1.0.0-alpha01 |
| 🧪 | [Ceres Core Notifications](/core/notifications) | dev.teogor.ceres:core-notifications | 1.0.0-alpha01 |
| 🧪 | [Ceres Core Runtime](/core/runtime) | dev.teogor.ceres:core-runtime | 1.0.0-alpha01 |
| 🧪 | [Ceres Core Startup](/core/startup) | dev.teogor.ceres:core-startup | 1.0.0-alpha01 |
| 🧪 | [Ceres Data Compose](/data/compose) | dev.teogor.ceres:data-compose | 1.0.0-alpha01 |
| 🧪 | [Ceres Data Database](/data/database) | dev.teogor.ceres:data-database | 1.0.0-alpha01 |
| 🧪 | [Ceres Data Datastore](/data/datastore) | dev.teogor.ceres:data-datastore | 1.0.0-alpha01 |
| 🧪 | [Ceres Firebase Analytics](/firebase/analytics) | dev.teogor.ceres:firebase-analytics | 1.0.0-alpha01 |
| 🧪 | [Ceres Firebase Crashlytics](/firebase/crashlytics) | dev.teogor.ceres:firebase-crashlytics | 1.0.0-alpha01 |
| 🧪 | [Ceres Firebase Remote-Config](/firebase/remote-config) | dev.teogor.ceres:firebase-remote-config | 1.0.0-alpha01 |
| 🧪 | [Ceres Framework Core](/framework/core) | dev.teogor.ceres:framework-core | 1.0.0-alpha01 |
| 🧪 | [Ceres Framework UI](/framework/ui) | dev.teogor.ceres:framework-ui | 1.0.0-alpha01 |
| 🧪 | [Ceres Monetisation AdMob](/monetisation/admob) | dev.teogor.ceres:monetisation-admob | 1.0.0-alpha01 |
| 🧪 | [Ceres Monetisation Messaging](/monetisation/messaging) | dev.teogor.ceres:monetisation-messaging | 1.0.0-alpha01 |
| 🧪 | [Ceres Navigation Common](/navigation/common) | dev.teogor.ceres:navigation-common | 1.0.0-alpha01 |
| 🧪 | [Ceres Navigation Core](/navigation/core) | dev.teogor.ceres:navigation-core | 1.0.0-alpha01 |
| 🧪 | [Ceres Navigation Events](/navigation/events) | dev.teogor.ceres:navigation-events | 1.0.0-alpha01 |
| 🧪 | [Ceres Navigation Screen](/navigation/screen) | dev.teogor.ceres:navigation-screen | 1.0.0-alpha01 |
| 🧪 | [Ceres Navigation UI](/navigation/ui) | dev.teogor.ceres:navigation-ui | 1.0.0-alpha01 |
| 🧪 | [Ceres Screen Builder](/screen/builder) | dev.teogor.ceres:screen-builder | 1.0.0-alpha01 |
| 🧪 | [Ceres Screen Core](/screen/core) | dev.teogor.ceres:screen-core | 1.0.0-alpha01 |
| 🧪 | [Ceres Screen UI](/screen/ui) | dev.teogor.ceres:screen-ui | 1.0.0-alpha01 |
| 🧪 | [Ceres UI Compose](/ui/compose) | dev.teogor.ceres:ui-compose | 1.0.0-alpha01 |
| 🧪 | [Ceres UI Design-System](/ui/designsystem) | dev.teogor.ceres:ui-designsystem | 1.0.0-alpha01 |
| 🧪 | [Ceres UI Foundation](/ui/foundation) | dev.teogor.ceres:ui-foundation | 1.0.0-alpha01 |
| 🧪 | [Ceres UI Icons](/ui/icons) | dev.teogor.ceres:ui-icons | 1.0.0-alpha01 |
| 🧪 | [Ceres UI Spectrum](/ui/spectrum) | dev.teogor.ceres:ui-spectrum | 1.0.0-alpha01 |
| 🧪 | [Ceres UI Theme](/ui/theme) | dev.teogor.ceres:ui-theme | 1.0.0-alpha01 |
| 🧪 | [core](/backup/core) | dev.teogor.ceres:backup-core | 1.0.0-alpha01 |
| 🧪 | [ui](/backup/ui) | dev.teogor.ceres:backup-ui | 1.0.0-alpha01 |
| 🚧 | [network](/core/network) | dev.teogor.ceres:core-network | 1.0.0 |
| 🧪 | [notifications](/core/notifications) | dev.teogor.ceres:core-notifications | 1.0.0-alpha01 |
| 🧪 | [runtime](/core/runtime) | dev.teogor.ceres:core-runtime | 1.0.0-alpha01 |
| 🧪 | [startup](/core/startup) | dev.teogor.ceres:core-startup | 1.0.0-alpha01 |
| 🧪 | [compose](/data/compose) | dev.teogor.ceres:data-compose | 1.0.0-alpha01 |
| 🧪 | [database](/data/database) | dev.teogor.ceres:data-database | 1.0.0-alpha01 |
| 🧪 | [datastore](/data/datastore) | dev.teogor.ceres:data-datastore | 1.0.0-alpha01 |
| 🧪 | [analytics](/firebase/analytics) | dev.teogor.ceres:firebase-analytics | 1.0.0-alpha01 |
| 🧪 | [crashlytics](/firebase/crashlytics) | dev.teogor.ceres:firebase-crashlytics | 1.0.0-alpha01 |
| 🧪 | [remoteconfig](/firebase/remote-config) | dev.teogor.ceres:firebase-remoteconfig | 1.0.0-alpha01 |
| 🧪 | [core](/framework/core) | dev.teogor.ceres:framework-core | 1.0.0-alpha01 |
| 🧪 | [ui](/framework/ui) | dev.teogor.ceres:framework-ui | 1.0.0-alpha01 |
| 🧪 | [admob](/monetisation/admob) | dev.teogor.ceres:monetisation-admob | 1.0.0-alpha01 |
| 🧪 | [messaging](/monetisation/messaging) | dev.teogor.ceres:monetisation-messaging | 1.0.0-alpha01 |
| 🧪 | [common](/navigation/common) | dev.teogor.ceres:navigation-common | 1.0.0-alpha01 |
| 🧪 | [core](/navigation/core) | dev.teogor.ceres:navigation-core | 1.0.0-alpha01 |
| 🧪 | [events](/navigation/events) | dev.teogor.ceres:navigation-events | 1.0.0-alpha01 |
| 🧪 | [screen](/navigation/screen) | dev.teogor.ceres:navigation-screen | 1.0.0-alpha01 |
| 🧪 | [ui](/navigation/ui) | dev.teogor.ceres:navigation-ui | 1.0.0-alpha01 |
| 🧪 | [builder](/screen/builder) | dev.teogor.ceres:screen-builder | 1.0.0-alpha01 |
| 🧪 | [core](/screen/core) | dev.teogor.ceres:screen-core | 1.0.0-alpha01 |
| 🧪 | [ui](/screen/ui) | dev.teogor.ceres:screen-ui | 1.0.0-alpha01 |
| 🧪 | [compose](/ui/compose) | dev.teogor.ceres:ui-compose | 1.0.0-alpha01 |
| 🧪 | [design.system](/ui/designsystem) | dev.teogor.ceres:ui-design.system | 1.0.0-alpha01 |
| 🧪 | [foundation](/ui/foundation) | dev.teogor.ceres:ui-foundation | 1.0.0-alpha01 |
| 🧪 | [icons](/ui/icons) | dev.teogor.ceres:ui-icons | 1.0.0-alpha01 |
| 🧪 | [spectrum](/ui/spectrum) | dev.teogor.ceres:ui-spectrum | 1.0.0-alpha01 |
| 🧪 | [theme](/ui/theme) | dev.teogor.ceres:ui-theme | 1.0.0-alpha01 |

### Explore Further

Expand Down
4 changes: 2 additions & 2 deletions docs/bom/versions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Ceres BoM (Bill of Materials)

The BOM (Bill of Materials) is the central hub for managing library versions within the Ceres project.
The BoM (Bill of Materials) is the central hub for managing library versions within the Ceres project.
It enables you to effortlessly keep track of the latest versions of key components and dependencies.

### Latest Version
Expand All @@ -20,7 +20,7 @@ Below is a list of the latest versions of the BOM:

| Version | Release Notes | Release Date |
| ------- | ------------- | ------------ |
| 1.0.0-alpha01 | [changelog 🔗](/docs/bom/1.0.0-alpha01/bom-version-1.0.0-alpha01.md) | 28 Sept 2023 |
| 1.0.0-alpha01 | [changelog 🔗](/docs/bom/1.0.0-alpha01/bom-version-1.0.0-alpha01.md) | 08 Nov 2023 |

The **Bill of Materials (BoM)** serves as a cornerstone for maintaining synchronization among various libraries and components in your project. By centralizing version management, it significantly reduces compatibility issues and streamlines the entire dependency management process.

Expand Down
16 changes: 10 additions & 6 deletions docs/ceres-module-backup.md → docs/ceres-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

| Status | Library | Gradle dependency |
| ------ | ------- | ----------------- |
| 🧪 | [Ceres Backup Core](/backup/core) | [dev.teogor.ceres:backup-core:1.0.0-alpha01](#implementation-ceres-backup-core) |
| 🧪 | [Ceres Backup UI](/backup/ui) | [dev.teogor.ceres:backup-ui:1.0.0-alpha01](#implementation-ceres-backup-ui) |
| 🧪 | [core](/backup/core) | [dev.teogor.ceres:backup-core:1.0.0-alpha01](#implementation-core) |
| 🧪 | [ui](/backup/ui) | [dev.teogor.ceres:backup-ui:1.0.0-alpha01](#implementation-ui) |

By referring to the [BoM documentation](/docs/bom/versions.md), you can learn how to integrate the BoM into your project and benefit from this hassle-free approach to library version management. It's a powerful tool for staying up-to-date with the latest Ceres library versions and seamlessly integrating them into your projects.


### Implementation Ceres Backup Core
### Implementation Core

To use Ceres Backup Core in your Android project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):
To use core in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:backup-core:1.0.0-alpha01")
Expand All @@ -22,9 +22,11 @@ implementation("dev.teogor.ceres:backup-core:1.0.0-alpha01")
- **Artifact ID:** `backup-core`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

### Implementation Ceres Backup UI
⚠️ Depends on `:data:database`,`:data:datastore`,`:backup:core`,`:data:database`,`:data:datastore`,`:backup:core`,`:backup:core`,`:data:database`,`:data:datastore`,`:backup:core`

To use Ceres Backup UI in your Android project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):
### Implementation UI

To use ui in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:backup-ui:1.0.0-alpha01")
Expand All @@ -36,4 +38,6 @@ implementation("dev.teogor.ceres:backup-ui:1.0.0-alpha01")
- **Artifact ID:** `backup-ui`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:backup:ui`,`:backup:ui`,`:backup:ui`,`:backup:ui`


77 changes: 77 additions & 0 deletions docs/ceres-core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
## Ceres core

| Status | Library | Gradle dependency |
| ------ | ------- | ----------------- |
| 🚧 | [network](/core/network) | [dev.teogor.ceres:core-network:1.0.0](#implementation-network) |
| 🧪 | [notifications](/core/notifications) | [dev.teogor.ceres:core-notifications:1.0.0-alpha01](#implementation-notifications) |
| 🧪 | [runtime](/core/runtime) | [dev.teogor.ceres:core-runtime:1.0.0-alpha01](#implementation-runtime) |
| 🧪 | [startup](/core/startup) | [dev.teogor.ceres:core-startup:1.0.0-alpha01](#implementation-startup) |

By referring to the [BoM documentation](/docs/bom/versions.md), you can learn how to integrate the BoM into your project and benefit from this hassle-free approach to library version management. It's a powerful tool for staying up-to-date with the latest Ceres library versions and seamlessly integrating them into your projects.


### Implementation Network

To use network in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:core-network:1.0.0")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `core-network`
- **Version:** `1.0.0` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:core:network`,`:core:network`,`:core:network`,`:core:network`

### Implementation Notifications

To use notifications in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:core-notifications:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `core-notifications`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:core:notifications`,`:core:notifications`,`:core:notifications`,`:core:notifications`

### Implementation Runtime

To use runtime in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:core-runtime:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `core-runtime`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:core:startup`,`:core:runtime`,`:core:startup`,`:core:runtime`,`:core:runtime`,`:core:startup`,`:core:runtime`

### Implementation Startup

To use startup in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:core-startup:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `core-startup`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:core:startup`,`:core:startup`,`:core:startup`,`:core:startup`


60 changes: 60 additions & 0 deletions docs/ceres-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
## Ceres data

| Status | Library | Gradle dependency |
| ------ | ------- | ----------------- |
| 🧪 | [compose](/data/compose) | [dev.teogor.ceres:data-compose:1.0.0-alpha01](#implementation-compose) |
| 🧪 | [database](/data/database) | [dev.teogor.ceres:data-database:1.0.0-alpha01](#implementation-database) |
| 🧪 | [datastore](/data/datastore) | [dev.teogor.ceres:data-datastore:1.0.0-alpha01](#implementation-datastore) |

By referring to the [BoM documentation](/docs/bom/versions.md), you can learn how to integrate the BoM into your project and benefit from this hassle-free approach to library version management. It's a powerful tool for staying up-to-date with the latest Ceres library versions and seamlessly integrating them into your projects.


### Implementation Compose

To use compose in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:data-compose:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `data-compose`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:data:database`,`:data:datastore`,`:data:compose`,`:data:database`,`:data:datastore`,`:data:compose`,`:data:compose`,`:data:database`,`:data:datastore`,`:data:compose`

### Implementation Database

To use database in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:data-database:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `data-database`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:data:database`,`:data:database`,`:data:database`,`:data:database`

### Implementation Datastore

To use datastore in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:data-datastore:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `data-datastore`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:core:startup`,`:data:datastore`,`:core:startup`,`:data:datastore`,`:data:datastore`,`:core:startup`,`:data:datastore`


60 changes: 60 additions & 0 deletions docs/ceres-firebase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
## Ceres firebase

| Status | Library | Gradle dependency |
| ------ | ------- | ----------------- |
| 🧪 | [analytics](/firebase/analytics) | [dev.teogor.ceres:firebase-analytics:1.0.0-alpha01](#implementation-analytics) |
| 🧪 | [crashlytics](/firebase/crashlytics) | [dev.teogor.ceres:firebase-crashlytics:1.0.0-alpha01](#implementation-crashlytics) |
| 🧪 | [remoteconfig](/firebase/remote-config) | [dev.teogor.ceres:firebase-remoteconfig:1.0.0-alpha01](#implementation-remoteconfig) |

By referring to the [BoM documentation](/docs/bom/versions.md), you can learn how to integrate the BoM into your project and benefit from this hassle-free approach to library version management. It's a powerful tool for staying up-to-date with the latest Ceres library versions and seamlessly integrating them into your projects.


### Implementation Analytics

To use analytics in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:firebase-analytics:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `firebase-analytics`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:firebase:analytics`,`:firebase:analytics`,`:firebase:analytics`,`:firebase:analytics`

### Implementation Crashlytics

To use crashlytics in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:firebase-crashlytics:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `firebase-crashlytics`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:firebase:crashlytics`,`:firebase:crashlytics`,`:firebase:crashlytics`,`:firebase:crashlytics`

### Implementation Remote-Config

To use remoteconfig in your project, add the following dependency to your module-level Gradle file (usually `app/build.gradle.kts`):

```kotlin
implementation("dev.teogor.ceres:firebase-remoteconfig:1.0.0-alpha01")
```

#### Gradle Dependency

- **Group ID:** `dev.teogor.ceres`
- **Artifact ID:** `firebase-remoteconfig`
- **Version:** `1.0.0-alpha01` (not required when using [BoM](/docs/bom/versions.md))

⚠️ Depends on `:firebase:remote-config`,`:firebase:remote-config`,`:firebase:remote-config`,`:firebase:remote-config`


Loading

0 comments on commit c0b5c2c

Please sign in to comment.