diff --git a/README.md b/README.md index 98e67f5..63609ac 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,83 @@ -# SiriusGame +# SiriusGame 🏆 -## Установка Swiftformat +![Swift](https://img.shields.io/badge/Swift-5.9-orange?logo=swift) +![Platform](https://img.shields.io/badge/iOS-17+-blue?logo=apple) +![CI/CD](https://img.shields.io/badge/CI/CD-Passing-success?logo=github) +![License](https://img.shields.io/badge/License-MIT-green) + +**Автоматизация соревнований** для образовательного центра «Сириус» с интерактивными оценками через AirDrop, live-трансляциями результатов, push-нотификацией для оповещения участников о ходе соревнований, картами и построением маршрутов. + +--- + +## 📱 Скриншоты UI +### Список событий + + +### Карта + + +### Работа Push и экран получения оценки + + +### Лидербоард + + + +### + +## 🎥 Видеодемо + + +https://github.com/user-attachments/assets/fe17ef9a-fb22-45f0-afaf-5b902a9fc019 + +## 🛠 Технологии + +### 📱 Клиент +- **Язык**: Swift 5.9 +- **UI**: SwiftUI + MapKit +- **Архитектура**: MVVM + Dependency Injection +- **Уведомления**: + - `UserNotifications` + APNs (оценки/анонсы) + - Live Activities (реал-тайм обновления) +- **AirDrop**: Deep Links для передачи оценок +- **Сеть**: Кастомный слой на URLSession + +### ⚙️ Инфраструктура +- **Бэкенд**: FastAPI (Python) +- **CI/CD**: + - Автопроверки сборки (`xcodebuild`) + - Линтинг (`SwiftFormat`) +- **Генерация проекта**: XcodeGen + +--- + +## ⚙️ Установка и настройка + +```bash +# 1. Клонируйте репозиторий +https://github.com/AlexOneZ/SiriusGame.git +cd SiriusGame + +# 2. Генерация проекта (через XcodeGen) +xcodegen generate + +# 3. Откройте проект в Xcode +open SiriusGame.xcworkspace ``` +## Установка Swiftformat +```bash brew install swiftformat ``` -## Запуск сервера -``` -cd backend -pip install -r requirements.txt -uvicorn main:app --reload -``` +## 🧑‍💻 Команда -## API +| Роль | Участник | GitHub | Контакты | +|--------------------|--------------------|---------------------------------------------|------------------------| +| iOS-разработчик | Андрей Степанов | [@TheRain231](https://github.com/TheRain231)| [@TheRain231](https://web.telegram.org/k/#@TheRain231) | +| iOS-разработчик | Мария Майорова | [@mariaamay](https://github.com/mariaamay) | [@by_mvm](https://web.telegram.org/k/#@by_mvm)| +| iOS-разработчик | Алексей Кобяков | [@AlexOneZ](https://github.com/AlexOneZ) | [@aleksey_k99](https://web.telegram.org/k/#@aleksey_k99) | +| iOS-разработчик | Илья Лебедев | [@realINL](https://github.com/realINL) | [@twa777](https://web.telegram.org/k/#@twa777) | +| Backend | Рамин Султангалиев | [@raminsultangaliev](https://github.com/raminsultangaliev) | [@rsul07](https://web.telegram.org/k/#@rsul07) | +| Backend | Михаил Батурин | [@Misha-Mayskiy](https://github.com/Misha-Mayskiy) | [@cubebug](https://web.telegram.org/k/#@cubebug) | -``` -https://siriusgame.a.pinggy.link/docs -``` \ No newline at end of file