Giter Club home page Giter Club logo

carapp's Introduction

Select a Car

Car selection app by picking up data of manufacturer, model and build date

kotlin compose Hilt Coroutines minSdkVersion targetSdkVersion MVI


Table of Contents

About the Project

Screenshots

Tech Stack

Mutable state is used in this project instead of Flows.

Installation

Download:

$ git clone https://github.com/SyedAmmarSohail/CarApp.git

Import Project by Android Studio Menu > File > Import Project.

Release:

This app is production ready, only need to add your keystore path, password and alias in build.gradle file located under the app folder.

Architecture

AppModule:

Used layer-based clean architecture in which include data, domain and presentation layer.

  • Data layer - Manages application data eg. retrieve data from the network, manage local data cache

  • Domain layer - Contains business logic with separate usecases

  • Presentation layer - Presents data to a screen and handle user interactions

BuildSrc:

Puts every dependencies in one place with respect to its classes, and use it by calling the dependency with its class.

Architecture Diagram

screenshot

Project tree

.
├── CarApp
├── app
    ├── carapp
        ├── carSelect
            ├── data
                ├── di
                    ├── CarDataModule
                ├── intercepter
                    ├── QueryInterceptor
                ├── mapper
                    ├── CarMapper.kt
                ├── remote
                    ├── dto
                        ├── CarResponse
                    ├── CarApi
                ├── repository
                    ├── CarRepositoryImp
            ├── domain
                ├── di
                    ├── CarDomainModule
                ├── model
                    ├── Type
                ├── repository
                    ├── CarRepository
                ├── usecase
                    ├── BuiltDataUsecase
                    ├── CarUseCase
                    ├── MainTypeUsecase
                    ├── ManufacturerUsecase
            ├── presentation
                ├── component
                    ├── ActionAppBar.kt
                    ├── ComposeBorderText.kt
                    ├── ComposeButton.kt
                    ├── ComposeTextWithBackground.kt
                    ├── ComposeVerticalList.kt
                    ├── DummyList.kt
                    ├── LinePlaceHolder.kt
                    ├── SearchTextField.kt
                    ├── ShimmerAnimation.kt
                ├── CarEvent.kt
                ├── CarScreen.kt
                ├── CarSummaryScreen.kt
                ├── carUiState
                ├── CarViewModel
                ├── sheetContentScreen.kt
            ├── utils
                ├── DefaultPaginator
                ├── Paginator
                ├── UiEvent
                ├── UiText
        ├── ui
            ├── theme
                ├── Color.kt
                ├── Dimensions.kt
                ├── FontSize.kt
                ├── Shape.kt
                ├── Theme.kt
                ├── Type.kt
        ├── CarApp
        ├── MainActivity
├── buildSrc
    ├── AndroidX
    ├── Build
    ├── Compose
    ├── Coroutines
    ├── DaggerHilt
    ├── Google
    ├── Kotlin
    ├── Moshi
    ├── ProjectConfig
    ├── Retrofit
    ├── Testing
└── .gitignore

Test Cases

Unit Test:

To run the unit tests for repository go to the CarRepositoryImpTest class under the test folder and run the tests.

End to End UI Test:

To run the end to end ui tests for the app go to the CarE2ETest class under the androidTest folder and run the tests.

Contact

Syed Ammar Sohail - [email protected]

carapp's People

Contributors

syedammarsohail avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.