Skip to content

rainbowcake/rainbowcake

dev
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

RainbowCake

Build Status

RainbowCake logo

RainbowCake is an Android architecture framework, providing tools and guidance for building modern Android applications. It builds on top of Jetpack, both in terms of code and ideas.

Some of the main goals of this architecture:

  • Give guidance on all aspects of the application, covering not just the View architecture,
  • Clearly separate concerns between different layers and components,
  • Always keep views in a safe and consistent state with ViewModels,
  • Handle configuration changes (and even process death) gracefully,
  • Make offloading work to background threads trivial.

While RainbowCake is heavily opinionated, it also encourages you to deviate from it as needed. Feel free to pick and choose the ideas and library artifacts provided according to your own application’s needs!

For more information, see the official documentation on rainbowcake.dev.

Note: RainbowCake is stable and maintained, but it's a framework from 2019, so browse and use it with that in mind. You'll find a lot of the same ideas in Google's official Guide to app architecture as well, which is updated more actively.

Setup

RainbowCake is available from MavenCentral.

repositories {
    mavenCentral()
}

It ships in several artifacts - feel free to pick and choose from them (for more info, see Dependencies):

dependencies {
    implementation "co.zsmb:rainbow-cake-core:1.6.0" // Core library (required)
    implementation "co.zsmb:rainbow-cake-dagger:1.6.0" // Dagger 2 support
    implementation "co.zsmb:rainbow-cake-hilt:1.6.0" // Dagger Hilt support
    implementation "co.zsmb:rainbow-cake-koin:1.6.0" // Koin support
    implementation "co.zsmb:rainbow-cake-navigation:1.6.0" // Navigation features
    implementation "co.zsmb:rainbow-cake-timber:1.6.0" // Internal logging through Timber
    testImplementation "co.zsmb:rainbow-cake-test:1.6.0" // Testing utilities
}

License

Copyright 2021 Marton Braun

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.