Практическое задание

Нужно разработать android приложение для просмотра GitHub репозиториев.

Во время работы над практическим заданием настоятельно рекомендуем обращаться к разделу Памятки для разработчика

Кликабельный прототип

Функциональные требования

1. Авторизация пользователя (personal access token)
2. Просмотр списка репозиториев пользователя (первые 10)
3. Просмотр детальной информации выбранного репозитория
   1. статистика (forks, stars, watchers)
   2. ссылка на web страницу репозитория
   3. лицензия
   4. readme

Технические требования

1. Реализация на Kotlin
2. Использовать XML Layouts для UI
3. Использовать Kotlin Gradle DSL
4. Использовать Retrofit для работы с REST API
5. Использовать RecyclerView для отображения списка
6. Использовать ConstraintLayout для экрана детальной информации
7. Использовать Android Navigation Component для переходов между экранами
8. Использовать View Binding для связывания верстки с кодом
9. Экраны делать с помощью Fragment (подход Single Activity)
10. Использовать Coroutines для асинхронности и многопоточности
11. Использовать Kotlinx.Serialization для парсинга json
12. Использовать ViewModel для реализации логики экранов
13. Использовать LiveData / StateFlow для обновления данных на UI
14. Использовать Dagger Hilt для внедрения зависимостей
15. Сохранять токен авторизации в хранилище устройства - SharedPreferences
16. Корректно обрабатывать ситуации "загрузка данных", "ошибка загрузки", "пустой список"
17. Корректно обрабатывать смену конфигурации
18. При перезапуске приложения авторизация должна сохраняться
19. Использовать локализацию для всех строк, показываемых пользователю
20. Использовать векторную графику везде, где это возможно
21. Обеспечить поддержку Android API 21

Классы Android-приложения

    
    class MainActivity: AppCompatActivity {
        // TODO:
    }

    class AuthFragment: Fragment {
        // TODO:
    }

    class RepositoriesListFragment: Fragment {
       // TODO:
    }

    class DetailInfoFragment: Fragment {
       // TODO:
    }

   class AuthViewModel {
      val token: MutableLiveData<String>
      val state: LiveData<State>
      val actions: Flow<Action>

      fun onSignButtonPressed() {
          // TODO:
      }
      
      sealed interface State {
         object Idle : State
         object Loading : State
         data class InvalidInput(val reason: String) : State
      }
      
      sealed interface Action {
         data class ShowError(val message: String) : Action
         object RouteToMain : Action
      }

      // TODO:
   }

   class RepositoryInfoViewModel {
      val state: LiveData<State>

      sealed interface State {
         object Loading : State
         data class Error(val error: String) : State

         data class Loaded(
            val githubRepo: Repo,
            val readmeState: ReadmeState
         ) : State
      }

      sealed interface ReadmeState {
         object Loading : ReadmeState
         object Empty : ReadmeState
         data class Error(val error: String) : ReadmeState
         data class Loaded(val markdown: String) : ReadmeState
      }

      // TODO:
   }
   
   class RepositoriesListViewModel {
      val state: LiveData<State>
      
      sealed interface State {
         object Loading : State
         data class Loaded(val repos: List<Repo>) : State
         data class Error(val error: String) : State
         object Empty : State
      }

      // TODO:
   }

   class AppRepository {
      suspend fun getRepositories(): List<Repo> {
         // TODO:
      }

      suspend fun getRepository(repoId: String): RepoDetails {
         // TODO:
      }

      suspend fun getRepositoryReadme(ownerName: String, repositoryName: String, branchName: String): String {
         // TODO:
      }
      
      suspend fun signIn(token: String): UserInfo {
         // TODO:
      }

      // TODO:
   }

   class KeyValueStorage {
      var authToken: String?
   }

Диаграмма классов

При реализации нужно придерживаться следующей диаграммы:

classDiagram class MainActivity:::android class AuthFragment:::android class RepositoriesListFragment:::android class DetailInfoFragment:::android class AuthViewModel:::android class RepositoryInfoViewModel:::android class RepositoriesListViewModel:::android class AppRepository:::android class KeyValueStorage:::android MainActivity --> AuthFragment MainActivity --> RepositoriesListFragment MainActivity --> DetailInfoFragment AuthFragment --> AuthViewModel RepositoriesListFragment --> RepositoriesListViewModel DetailInfoFragment --> RepositoryInfoViewModel RepositoryInfoViewModel --> AppRepository AuthViewModel --> AppRepository RepositoriesListViewModel --> AppRepository AppRepository --> KeyValueStorage

Материалы

1. GitHub REST API
2. GitHub Basic Authorization
3. GitHub user repositories
4. Kotlinx.Serialization guide
5. Интеграция Kotlinx.Serialization и Retrofit
6. Дизайн