Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 3.18 KB

README.md

File metadata and controls

101 lines (76 loc) · 3.18 KB
Raw

Message License

Starter Android is a Codebase for your Android Project with Clean Architecture and Modular Architecture , the Codebase contains all abstraction and Infrastructure u need to build Complex Apps.

AndroidLibray

Table of contents

Description

  • all Components of Project are Completely Reusable.
  • The project depends on Navigation Jetpack Compose, u can build seperated Navigation Host with related screens.
  • There is Factory to create awesome NavHost to build related Screens.
  • support Error Handling with scope of App.
  • contains AppViewModel: abstraction for viewmodels .
  • contains CoroutinesRequester: for handling all your requests .
  • contains AppSCreen: abstraction layer of your screens by Navigation Compose.
  • contains NavControllerHost: manage hosing between screens.

Software Stack

  • Kotlin
  • MVVM
  • Android JetPack
  • Retrofit 2
  • Hilt dagger (U can replace with Koin if needed)
  • Coroutines
  • jetpack Compose
  • Navigation Compose
  • Clean Architecture
  • Modular Architecture (domain - adata - presenatation) layers
  • Design Patterns: Startegy , Templete Method , Factory , SingleTon Patterns.

clean-architecture

Why Modular Architecture ?

  • The Project is Clean , Testable , Maintainable and changable
  • High quality App with high cohesion and low coupling
  • Build Time
  • Development Can be Divided
  • Readable Programs
  • Programming Errors are Easy to Detect
  • Allows Re-Use of Codes
  • Improves Manageability
  • Collaboration

Installation

  1. clone the project in android studio
  2. change applicationID (packageName ) as you like.
  3. change the app ame.
  4. may need to sync , clean then rebuild the project.

Demo

Albums App example app demonstrates how reusabilty , maintainablilty , changability and readability are Provided.

👏 Contribution

  • PRs are welcome, let's make this library better. 🙌

  • please ⭐ if you like the idea!

Check my last lecture about Clean architecture and Clean Code Lecture

License

Apache License, Version 2.0

click to reveal License 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
   https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.