Skip to content
This repository has been archived by the owner on Jan 21, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
miamib34ch committed Sep 4, 2023
1 parent d3b9a25 commit e2ca6b7
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Image Feed
# **ImageFeed**

# Ссылки
## **Ссылки**

- [Дизайн в Figma](https://tinyurl.com/image-feed-figma)
- [Unsplash API](https://unsplash.com/documentation)
- [Скринкаст готового приложения]()

# Назначение и цели приложения
## **Назначение и цели приложения**

Многостраничное приложение предназначено для просмотра изображений через API Unsplash.

Expand All @@ -14,16 +15,16 @@
- Просмотр бесконечной ленты картинок из Unsplash Editorial.
- Просмотр краткой информации из профиля пользователя.

# Краткое описание приложения
### Краткое описание приложения

- В приложении обязательна авторизация через OAuth Unsplash.
- Главный экран состоит из ленты с изображениями. Пользователь может просматривать ее, добавлять и удалять изображения из избранного.
- Пользователи могут просматривать каждое изображение отдельно и делиться ссылкой на них за пределами приложения.
- У пользователя есть профиль с избранными изображениями и краткой информацией о пользователе.

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

# Авторизация через OAuth
### Авторизация через OAuth

Для входа в приложение пользователь должен авторизоваться через OAuth.

Expand All @@ -44,7 +45,7 @@
1. При нажатии на «ОК» пользователь переходит обратно на экран авторизации;
5. Если авторизация прошла успешно, то браузер закрывается. В приложении открывается экран с лентой.

## Просмотр ленты
### Просмотр ленты

В ленте пользователь может просматривать изображения в ленте, переходить к просмотру отдельного изображения и добавлять их в избранное.

Expand Down Expand Up @@ -72,7 +73,7 @@
7. При нажатии на иконку профиля пользователь может перейти в профиль;
8. Пользователь может переключаться между экранами ленты и профиля с помощью таб бара.

## Просмотр изображения на весь экран
### Просмотр изображения на весь экран

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

Expand All @@ -95,7 +96,7 @@
2. Пользователь может закрыть меню свайпом вниз или при нажатии на крестик;
3. Если открытие системного меню при нажатии на кнопку “загрузить или поделиться изображением” не настроено — оно не будет показываться;

## Просмотр профиля пользователя
### Просмотр профиля пользователя

Пользователь может перейти в свой профиль, чтобы посмотреть данные профиля или выйти из него.

Expand All @@ -119,12 +120,13 @@
3. Если алерт не настроен, то при нажатии на кнопку выхода ничего не происходит, пользователь не может разлогиниться;
3. Пользователь может переключаться между экранами ленты и профиля с помощью таб бара.

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

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

1. Авторизация работает через OAuth Unsplash и POST запрос для получения Auth Token.
2. Лента реализована с помощью UITableView.
3. В приложении использованы UImageView, UIButton, UILabel, TabBarController, NavigationController, NavigationBar, UITableView, UITableViewCell.
4. Приложение должно поддерживать устройства iPhone с iOS 13 или выше, предусмотрен только портретный режим.
5. Все шрифты в приложении должны быть выбраны из множества стандартных для платформы (для iOS 13 - это [SF Pro](https://developer.apple.com/fonts/)).
6. Используются внешние зависимости через SPM: Kingfisher, ProgressHUD, SwiftKeychainWrapper.

## **Инструкция по запуску**

0 comments on commit e2ca6b7

Please sign in to comment.