Skip to content
SuperHeroes kata for Jetpack Developers in Kotlin
Branch: master
Clone or download

README.md

Karumi logo Kata SuperHeroes with Jetpack in Kotlin Build Status


Getting started

This repository contains an Android application to show Super Heroes information:

ApplicationScreencast

This Application is based on three Activities:

  • MainActivity showing a list of super heroes with name, photo and a special badge if it is part of the Avengers Team.

MainActivity screenhot

  • SuperHeroDetailActivity showing detailed information about a super hero like his or her name, photo and description.

SuperHeroDetailActivity screenshot

  • EditSuperHeroActivity: Display options to change some attributes of a superhero like their Avengers badge, their name and their description.

EditSuperHeroActivity screenshot

The application architecture, dependencies and configuration is ready to just start migrating code to Jetpack.

To verify the correct behaviour of your code you can execute:

./gradlew executeScreenshotTests

To be able to get a deterministic test scenario all our tests will be executed on the same emulated device. Run the following to create an emulator like the one we used to get all the reference screenshots:

./script/start_emulator.sh

Tasks

Your task as Android Developer is to migrate the application to Jetpack architecture components. You will do so step by step and always using tests to verify everything is still working.

Our recommendation for this exercise is:

  • Before starting
    1. Fork this repository.
    2. Checkout 00-start branch.
    3. Execute the application, explore it manually and make yourself familiar with the code.
    4. Execute MainActivityTest, SuperHeroDetailActivityTest and EditSuperHeroActivityTest to see tests run.
  • Feel free to migrate at your own pace and order but if you want to make it a bit easier, follow this order:
    1. Lifecycle
    2. Room
    3. DataBinding, LiveData and ViewModel
    4. Paging
    5. Navigation
    6. WorkManager

Considerations

If you get stuck, master branch contains the finished kata using all architecture components. There are also tags for every single new component following the above order and PRs for them showcasing what are the steps we followed to migrate the whole project.


Documentation

There are some links which can be useful to finish these tasks:

Data provided by Marvel. © 2019 MARVEL

License

Copyright 2019 Karumi

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.

You can’t perform that action at this time.