https://github.com/kupriyanovnik/bikestat

an application written in SwiftUI, which may be useful for cyclists
https://github.com/kupriyanovnik/bikestat

async-await coredata corelocation mvvm swiftui

Last synced: about 1 month ago
JSON representation

an application written in SwiftUI, which may be useful for cyclists

• Host: GitHub
• URL: https://github.com/kupriyanovnik/bikestat
• Owner: kupriyanovNik
• License: mit
• Created: 2023-12-26T17:26:16.000Z (over 1 year ago)
• Default Branch: develop
• Last Pushed: 2024-02-09T21:02:48.000Z (about 1 year ago)
• Last Synced: 2025-01-23T21:53:50.007Z (3 months ago)
• Topics: async-await, coredata, corelocation, mvvm, swiftui
• Language: Swift
• Homepage:
• Size: 278 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# **BikeStat 🚲**

![МОШ](https://predprof.olimpiada.ru/images/logo-predporf.svg)

![Xcode](https://img.shields.io/badge/Xcode-007ACC?style=for-the-badge&logo=Xcode&logoColor=white)

![Swift](https://img.shields.io/badge/swift-F54A2A?style=for-the-badge&logo=swift&logoColor=white)

![iOS](https://img.shields.io/badge/iOS-000000?style=for-the-badge&logo=ios&logoColor=white)

![Figma](https://img.shields.io/badge/figma-%23F24E1E.svg?style=for-the-badge&logo=figma&logoColor=white)

## Добро пожаловать в репозиторий!

### Видео-демонстрация работоспособности 

[Rutube](https://rutube.ru/video/ce33ff3d1f01ee3422ef5ccf2b53beee/)

### Разработчики 

1. [Никита Куприянов](https://github.com/kupriyanovNik)

2. [Анфиса Опарина](https://github.com/Anfisok)

### Описание

Наше приложение написано на [SwiftUI](https://developer.apple.com/xcode/swiftui/) и предназначено для устройств с операционной системой [iOS 16](https://ru.wikipedia.org/wiki/IOS_16) и новее. 

Оно предоставляет пользователям [удобный и интуитивно понятный интерфейс](https://www.figma.com/file/9rCteZ4QIBH2Uw3MMreihN/the-true-bikestat?type=design&node-id=441%3A1121&mode=design&t=SWfG9qbFdvQHJvIh-1) для отслеживания прогресса тренировок велосипедистов. 

### Основной функционал

- В приложении есть возможность планировать поездки заранее: пользователь может дать название поездке, выбрать дату и время начала, длину маршрута и желаемое время нахождения в пути. После сохранения запланированной поездки мы анализируем введенные данные и формируем **расчетную** сложность. 

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

- После завершения поездки информация о ней **сохраняется** в базу данных [CoreData](https://developer.apple.com/documentation/coredata/) и отображается на экране истории поездок. Пользователь может посмотреть сохраненные данные, которые включают в себя название, дату и время, пройденное расстояние, время в пути, информацию о скорости и пульсе, затраченные калории, расчетную и реальную сложности.

- Приложение умеет давать пользователю **рекомендации о сложности** следующей поездки и советы для личного развития, основываясь на данных о предыдущих маршрутов. Для отображения рекомендаций нужно совершить минимум 3 поездки.

### :smile:Наше приложение помогает велосипедистам эффективнее проводить тренировки и улучшать свои навыки!

### Управление проектом: [GitHub Projects](https://github.com/users/kupriyanovNik/projects/4)

### Особенности

- [Простой и понятный интерфейс](https://www.figma.com/file/9rCteZ4QIBH2Uw3MMreihN/the-true-bikestat?type=design&node-id=441%3A1121&mode=design&t=SWfG9qbFdvQHJvIh-1)

- Использование [SwiftUI](https://developer.apple.com/xcode/swiftui/)

- Поддержка [iOS 16](https://ru.wikipedia.org/wiki/IOS_16) и выше

- Возможность выбрать цветовую гамму приложения (🩵 / 💙 / 💜)

- Возможность выбрать единицы измерения скорости и расстояния (километры / мили)

### Краткая техническая информация 

- Архитектура: [MVVM](https://ru.wikipedia.org/wiki/Model-View-ViewModel)+S

- Локальное сохранение данных: [CoreData](https://developer.apple.com/documentation/coredata/)

- Сетевой слой на [async/await](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/concurrency/)

- Карта: [MapKit](https://developer.apple.com/documentation/mapkit/)

- Unit-тестирование: [XCTest](https://developer.apple.com/documentation/xctest)

### Установка

###### Для запуска приложения на устройстве нужен компьютер с установленной MacOS и телефон работающий под управлением операционной системы iOS

Для установки приложения необходимо выполнить следующие шаги:

1. Скачивание репозитория на локальный компьютер

  

  - Открыть терминал

  - Ввести следующие команды

    + cd путь_к_папке_в_которую_нужно_скопировать

    + git clone https://github.com/kupriyanovNik/BikeStat.git

  - Закрыть терминал (опционально)

2. Открытие проекта

  

 - Запустить [Xcode](https://developer.apple.com/xcode/)

  - Одновременно нажать cmd + shift + 1

  - Нажать "Open Existing Project..."

  - Найти в файловой системе скопированную папку

  - В папке выделить файл "BikeStat.xcodeproj"

  - Нажать кнопку "Open" / нажать "return" или "Enter" на клавиатуре (зависит от раскладки)

  - Следующие шаги раздела необходимы **только** для запуска на физическом устройстве

  - Перейти в Project Navigator (одновременно нажать cmd + 1)

  - Нажать на корневой элемент в файловой системе проекта (иконка Xcode, справа от которой будет написано BikeStat)

  - В появившемся окне выбрать вкладку "Signing & Capabilities"

  - Поменять [BundleID](https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids) на собственный

3. Запуск проекта на физическом устройстве или в симуляторе

  - Одновременно нажать cmd + shift + 2

  - Выбрать симулятор или физическое устройство в качестве Run Destination

  - Закрыть окно выбора Run Destination (красная кнопка слева сверху / одновременно нажать cmd + w)

  - Запустить (в верхнем меню Product -> Run / одновременно нажать cmd + r)

### Лицензия

Проект лицензирован в соответствии с условиями лицензии [LICENSE.md](https://github.com/kupriyanovNik/BikeStat/blob/develop/LICENSE).

### Контакты

Если у вас есть вопросы или предложения, пожалуйста, свяжитесь с нами:

- Почта [[email protected]](mailto:[email protected]) или [[email protected]](mailto:[email protected])

- Telegram @idontknowktoya или @anfisochik

- Добавить [issue](https://github.com/kupriyanovNik/BikeStat/issues/new)

- Обсуждения [GitHub Discussions](https://github.com/kupriyanovNik/BikeStat/discussions)