Skip to content
Игорь Соколов edited this page Aug 19, 2024 · 16 revisions

Дипломный проект Яндекс.Практикума по курсу "Android-разработчик"

Проект представляет собой стартовую точку для разработки дипломного проекта Яндекс.Практикума по курсу "Android-разработчик".

На каждый созданный pull request CI-сервер:

  • Скомпилирует проект и соберёт APK приложения, описанного в модуле app. Готовый APK можно скачивать на свой телефон или передавать на тестирование другим разработчикам или ревьюверам.
  • И запустит статический анализатор detekt, чтобы подсветить наличие или отсутствие ошибок, которые можно обнаружить, не запуская приложение. В частности, это поможет вам соблюдать принятый на проекте код-стайл.

Файл develop.properties не хранится в истории коммитов, однако значение токена API HeadHunter необходимо для успешной сборки APK приложения. Чтобы CI-сервер смог получить значение токена, его нужно добавить в секреты репозитория для Github Actions.

Техническое задание

Дипломный проект представляет собой небольшое приложение для поиска работы, использующее API сервиса HeadHunter. Приложение предоставляет следующую функциональность:

  • Поиск вакансий;
  • Указание фильтров для поиска;
  • Просмотр деталей отдельной вакансии;
  • И добавление вакансий в список "Избранного".

Ниже представлен список требований и особенностей различных экранов приложения, ознакомьтесь с ним до начала разработки.

Общие требования

  • Приложение должно поддерживать устройства, начиная с Android 8.0 (minSdkVersion = 26)
  • Приложение поддерживает только портретную ориентацию (portrait), при перевороте экрана ориентация не меняется.

Главный экран -- экран поиска вакансий

На этом экране пользователь может искать вакансии по любому непустому набору слов поискового запроса. Результаты поиска представляют собой список, содержащий краткую информацию о вакансиях.

Особенности экрана

Несколько особенностей экрана, которые нужно учитывать при реализации:

  • По умолчанию, поиск происходит по всей доступной базе вакансий без учёта региона, отрасли компании и уровня зарплаты и валюты.
  • Приложение не хранит историю поиска, поэтому между перезапусками приложения текст в поле ввода не обязан сохраняться.
  • При вводе нового текста в поле ввода мы осуществляем новый поиск с debounce в 2000 миллисекунд.
  • В отдельном элементе списка может быть картинка логотипа компании, которую нужно дополнительно загрузить. В процессе загрузки картинки и в случае ошибки загрузки этой картинки мы показываем плейсхолдер. Также плейсхолдер отображается, если информации о картинке нет.
  • В зависимости от пришедших с сервера данных информация о вакансии может отображаться несколькими способами:
    • "От XX";
    • "До XX";
    • "От XX до XX";
    • "Зарплата не указана".
  • Если в вакансии указана зарплата, то числа должны отображаться с разбиением на разряды (то есть 1 000 000, 12 345 678).
  • Зарплата в вакансии может быть указана в разной валюте, не только в рублях. Вот полный список возможных валют:
    • Российский рубль (RUR / RUB)
    • Белорусский рубль (BYR)
    • Доллар (USD)
    • Евро (EUR)
    • Казахстанский тенге (KZT)
    • Украинская гривна (UAH)
    • Азербайджанский манат (AZN)
    • Узбекский сум (UZS)
    • Грузинский лари (GEL)
    • Киргизский сом (KGT)
  • (*) В целях экономии трафика пользователей загрузка результатов поиска должна происходить постранично (paging) по 20 элементов за раз. Запрос на следующую страницу должен происходить, когда пользователь доскроллил до последнего доступного элемента списка (или чуть раньше).

Фильтрация -- набор экранов фильтров поиска

Используя настройки фильтра, пользователь может уточнить некоторые параметры поиска, который осуществляется на экране "Поиск". Фильтр позволяет указать:

  • Место работы - регион, населённый пункт, указанный в вакансии как рабочая локация.
  • Отрасль - сфера деятельности организации, разместившей вакансию.
  • Уровень зарплаты - уровень ЗП, соответствующий указанному в вакансии.
  • Возможность скрывать вакансии, для которых не указана ЗП.

Особенности экранов

Несколько особенностей, которые нужно учитывать при реализации:

  • Параметры фильтра не являются обязательными - пользователь может уточнить любой параметр из предложенных, а может не указывать ничего. В случае, если указан хотя бы один из параметров он должен учитываться при последующих поисковых запросах на экране "Поиск". Параметры фильтра, которые пользователь не уточнял, в поисковом запросе участвовать не должны.
  • Настройки параметров фильтра должны сохраняться даже после закрытия приложения.
  • Поиск по отраслям компании ведётся сразу по всем элементам дерева отраслей, без разделения на категории по уровням вложенности.
  • Экраны фильтрации отображаются поверх нижней навигации.
  • Если у пользователя выбрана страна поиска вакансий, то список регионов на экране выбора региона поиска ограничивается регионами указанной страны.
  • Если пользователь выбрал город до выбора страны, то страна должна подставляться автоматически.
  • Кнопка "Сбросить" появляется, если пользователь указал хотя бы одно значение фильтров.
  • Нажатие на кнопку «Применить» на экране фильтра возвращает пользователя на экран поиска. И если поле ввода поискового запроса было не пустым, то этот поисковый запрос должен автоматически выполниться повторно с применением актуальных настроек фильтрации.
  • Все настройки фильтра сохраняются автоматически сразу после изменения.

Экран просмотра деталей вакансии

Нажав на элемент списка найденных вакансий (аналогично в списке избранного), пользователь попадает на экран с подробным описанием вакансии. Помимо уровня ЗП, требуемого опыта и графика работы пользователь может на этом экране увидеть:

  • Информацию о работодателе
  • Подробное описание вакансии
  • Перечень требуемых ключевых навыков
  • Контактную информацию

Также пользователь может поделиться ссылкой на данную вакансию и связаться с работодателем через указанные контакты.

Особенности экрана

Несколько особенностей экрана, которые нужно учитывать при реализации:

  • Любая часть описания деталей вакансии опциональна, то есть из сети может не прийти какое-то из ожидаемых полей. В этом случае программа должна корректно работать и отображать те данные, которые у неё есть.
  • Подробное описание вакансии приходит в HTML-формате, напрямую отобразить полученное по сети поле не получится.
  • Отображение указанной зарплаты и валюты должно происходить аналогично выдаче поиска вакансий.
  • При нажатии на указанный адрес электронной почты должен открываться диалог с предложением написать email на этот адрес.
  • При нажатии на указанный номер телефона приложение должно открыть приложение для звонка, в котором уже будет отображён номер телефона.
  • Экраны деталей вакансии отображаются поверх нижней навигации.
  • Запрос на детали вакансии может вернуть 404, если вакансию удалили на сервере или у пользователя нет прав для её просмотра. В этом случае нужно не только корректно отобразить ошибку, но и удалить сохранённые детали этой вакансии из локальной БД.

Экран избранных вакансий

Пользователь может добавлять вакансии в "Избранное", чтобы иметь возможность быстро вернуться к заинтересовавшему его предложению. Добавить вакансию в "избранное" (или удалить из "избранного") можно на экране "Вакансия". Все вакансии, добавленные в закладки, можно увидеть на отдельном экране в приложении.

Особенности экрана

Несколько особенностей экрана, которые нужно учитывать при реализации:

  • Вакансии, добавленные в "избранное" можно просматривать без подключения к интернету. Если нет интернета, вместо логотипа компании можно показывать плейсхолдер.
  • Если пользователь добавляет вакансию в закладки, она должна сразу появиться на экране списка закладок.
  • (*) Список избранных вакансий может содержать довольно много вакансий, поэтому для ускорения загрузки экрана можно добавить пагинацию для выдачи избранных вакансий.

Экран информации о команде разработчиков

На экране отображается статический список людей, участвовавших в разработке приложения.

Clone this wiki locally