Skip to content

Latest commit

 

History

History
104 lines (91 loc) · 5.08 KB

README.md

File metadata and controls

104 lines (91 loc) · 5.08 KB
Raw

🍔 FastFood

An Android application where you can view and examine the details of fast food divided into categories.

🛠 Tech Stack & Open-Source Libraries

  • Kotlin - Google officially supports Kotlin on Android as a “first-class” language and it has a a lot of benefits.

  • Coroutines - A coroutine is a concurrency design pattern that can use on Android to simplify code that executes asynchronously.

  • MVVM Architecture - Modern, maintainable, and Google-suggested app architecture.

  • Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.

    • A single-activity architecture, using the Navigation component to manage fragment operations.
    • ViewBinding - Generates a binding class for each XML layout file present in that module and allows you to write code more easily that interacts with views.
    • LiveData - Data objects that notify views when the underlying database changes.
    • Lifecycle - Perform an action when lifecycle state changes.
    • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
    • Repository - Located in the data layer that contains application data and business logic.

  • Dependency Injection

    • Hilt - Easy implementation and less boilerplate code than Dagger2.

  • Networking

    • Retrofit - A type-safe HTTP client for Android and Java.
    • OkHttp - An HTTP client that efficiently make network requests.

  • Image Loading

    • Glide - An image loading and caching library for Android focused on smooth scrolling.

  • Design

    • Material Design 3 - Material Design is an adaptable system of guidelines, components, and tools that support the best practices of user interface design. Backed by open-source code, Material Design streamlines collaboration between designers and developers and helps teams quickly build beautiful products.
    • Shimmer for Android - An Android library that provides an easy way to add a shimmer effect to any view in an Android app.

  • Github Actions

    • Ktlint - An anti-bikeshedding Kotlin linter with built-in formatter.
    • Integrated CI/CD - Create a release on each pull request.

Package Structure

fastfood/          # Root package
|
├─ data/           # Data layer
│  ├─ remote/      # Api service
│  ├─ model/       # Data transfer objects for remote response
│  ├─ mapper/      # Mapper for remote responses
│  ├─ repository/  # Repository implementations
|
├─ di/             # Dependency-injection module
|
├─ domain/         # Domain layer
│  ├─ model/       # UI model
│  ├─ repository/  # Repository interfaces
│  ├─ util/        # Mapper interfaces
|
├─ ui/             # Presentation layer
│  ├─ detail/      # Product details
│  ├─ home/        # Main screen (Products, categories)
|
├─ util/           # Utility classes
│  ├─ extension/   # Kotlin extensions

License

MIT License

Copyright (c) 2022 Muhammed Esad Cömert

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.