KykScraped

🇹🇷 Türkçe | 🇬🇧 English

KykScraped is a modern Android application that displays daily menu information for KYK dormitories in Turkey. The app allows users to check breakfast and dinner menus for different cities.

Features

• View menus for different cities across Turkey
• Toggle between breakfast and dinner menus
• Display multiple days of menu information
• Real-time data fetching via web scraping
• Modern Material 3 UI with Jetpack Compose
• Calorie information for each menu (when available)

Architecture

The application follows Clean Architecture principles with MVVM pattern:

KykScraped/
├── data/           # Data layer (APIs, DTOs, Repositories implementation)
├── domain/         # Domain layer (Business logic, Models, Use cases)
└── presentation/   # UI layer (Screens, ViewModels)

Key components:

• Clean Architecture
• MVVM
• Dependency Injection
• Kotlin Coroutines
• Jetpack Compose
• Repository Pattern
• Web Scraping

Tech stack

• Kotlin: Primary programming language
• Jetpack Compose: Modern UI toolkit
• Material 3: Design system
• Hilt: Dependency injection
• Ktor: Networking client
• JSoup: HTML parsing
• Coroutines: Asynchronous programming
• ViewModel: UI state management
• Flow: Reactive programming

Getting started

Prerequisites

• Android Studio Iguana 2023.2.1 or newer
• Android SDK 35
• JDK 17 or newer

Installation

1. Clone the repository:

   git clone https://github.com/tamersarioglu/kykscraped.git

2. Open the project in Android Studio
3. Sync Gradle files and build the project
4. Run the application on an emulator or physical device

Configuration

The application uses the following configurations:

• minSdk: 24
• targetSdk: 35
• compileSdk: 35

Project structure

├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/com/tamersarioglu/kykscraped/
│   │   │   │   ├── data/
│   │   │   │   │   ├── mapper/
│   │   │   │   │   ├── model/
│   │   │   │   │   ├── remote/
│   │   │   │   │   └── repository/
│   │   │   │   ├── di/
│   │   │   │   ├── domain/
│   │   │   │   │   ├── model/
│   │   │   │   │   ├── repository/
│   │   │   │   │   ├── usecase/
│   │   │   │   │   └── util/
│   │   │   │   ├── presentation/
│   │   │   │   │   ├── menu/
│   │   │   │   └── ui/theme/
│   │   │   └── res/

Usage

1. Select a city from the dropdown menu
2. Toggle between breakfast and dinner menus using the switch
3. View the daily menus for the selected city and meal type

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Author

• Tamer Sarioglu

Acknowledgments

• Kykyemek.com for providing the menu data