NCS Shop

NCS Shop is built with modern Android development tools. Aim of this project is to showcase good practice implementation of Android application development with reliable architecture

Features

The codebase focuses on following key things:

• Single Activity Design
• Multi-module architecture
• Jetpack Compose/XML UI
• Unit Tests
• Dark theme
• Notifications

Design

Click below to see full design system of this app

Architecture

This app follows principles of Clean Architecture, and therefore is separated into three layers. Data and Presentation layers are additionally modularized, with Data layer divided by data source and Presentation layer being multi-module by feature.

Domain layer

• Contains all of the core entity classes, upon which the rest of the app is built
• Defines interfaces of repositories
• Encapsulates business logic inside Use Case classes

Data layer

• Implements repositories from the domain layer
• Fetches content from the API
• Stores visited products and search history in Room database
• Uses Firebase to manage authentication and obtain data of the current user

Presentation layer

App module

• Depends on every other module to initialize DI
• Contains the application class as well as the main activity
• Controls the navigation

UI feature modules

Each module is responsible for one logical feature of the app. All features implement MVVM architecture, with the exception of User feature, which uses MVI approach to ease interaction with Compose

Core module

• Contains shared resources and utils for all UI feature modules
• Defines the navigation contract of this app, having MarketplaceNavigator interface as well as every NavDestintaion supported

Built with

• Kotlin - First class and official programming language for Android development.

• Coroutines - For asynchronous and more..

• Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.

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

• ViewModel - Stores UI-related data that survives configuration changes.

• ViewBinding - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.

• Room - An object mapping library powered by SQLite.

• WorkManager - Makes it easy to schedule deferrable, asynchronous tasks that are expected to run even if the app exits or the device restarts.

• Navigation Component - eases navigating across, into, and back out from the different pieces of content within your app.

• Koin - A pragmatic lightweight dependency injection framework for Kotlin developers. Koin is a DSL, a light container and a pragmatic API

• Retrofit - A type-safe HTTP client for Android and Java

• Material Components for Android - Modular and customizable Material Design UI components for Android.

• JUnit - Unit testing framework for the Java/Kotlin

• Jetpack Compose - Modern UI development toolkit.

• Mockk - Mocking library for Kotlin.

• Coil - An image loading library for Android backed by Kotlin Coroutines.

• Orbit - A redux/MVI-like library - but without the baggage.

• Lottie - Natively renders Adobe After Effects exported animations

• Firebase - Stores data in the cloud and provides tools for tracking analytics, reporting and fixing app crashes, creating marketing and product experiment.