The circles represent different layers of your app. Note that:

• The center circle is the most abstract, and the outer circle is the most concrete. This is called the Abstraction Principle. The Abstraction Principle specifies that inner circles should contain business logic, and outer circles should contain implementation details.

• Another principle of Clean Architecture is the Dependency Inversion. This rule specifies that each circle can depend only on the nearest inward circle ie. low-level modules do not depend on high-level modules but the other way around.

Why Clean Architecture?

• Loose coupling between the code - The code can easily be modified without affecting any or a large part of the app's codebase thus easier to scale the application later on.
• Easier to test code.
• Separation of Concern - Different modules have specific responsibilities making it easier for modification and maintenance.

S.O.L.I.D Principles

• Single Responsibility: Each software component should have only one reason to change – one responsibility.

• Open-Closed: You should be able to extend the behavior of a component, without breaking its usage, or modifying its extensions.

• Liskov Substitution: If you have a class of one type, and any subclasses of that class, you should be able to represent the base class usage with the subclass, without breaking the app.

• Interface Segregation: It’s better to have many smaller interfaces than a large one, to prevent the class from implementing the methods that it doesn’t need.

• Dependency Inversion: Components should depend on abstractions rather than concrete implementations. Also higher level modules shouldn’t depend on lower level modules.

Layers

Project Structure

Component

The component layer is responsible for common view components that using app.

Core

The core layer is contains different utilities that can be used by the different modules and base structures.

Data

The data layer is responsible for selecting the proper data source for the domain layer. It contains the implementations of the repositories declared in the domain layer.

Components of data layer include:

• model

  -dto: Defines dto of ui model, also perform data transformation between domain, response and entity models.

  -local: Defines the schema of Core Data database.

  -remote: Defines POJO of network responses.

• local: This is responsible for performing caching operations using Core Data.

• remote: This is responsible for performing network operations eg. defining API endpoints using Combine.

• repository: Responsible for exposing data to the domain layer.

Domain

This is the core layer of the application. The domain layer is independent of any other layers thus ] domain business logic can be independent from other layers.This means that changes in other layers will have no effect on domain layer eg. screen UI (presentation layer) or changing database (data layer) will not result in any code change withing domain layer.

Components of domain layer include:

• usecase: They enclose a single action, like getting data from a database or posting to a service. They use the repositories to resolve the action they are supposed to do. They usually override the operator invoke , so they can be called as a function.

Presentation

The presentation layer contains components involved in showing information to the user. The main part of this layer are the Views and ViewModels.

Demo Screenshots

Tech Stacks

This project uses many of the popular libraries, plugins and tools of the android ecosystem.

• MVVM - the viewmodel is responsible for exposing (converting) the data objects from the model in such a way that objects are easily managed and presented..
• Resolver - Dependency Injection library.
• Combine - Customize handling of asynchronous events by combining event-processing operators.
• Core Data - Persist or cache data on a single device, or sync data to multiple devices with CloudKit.
• Lottie - JSON-based animation file format that enables designers to ship animations on any platform as easily as shipping static assets.
• Paging - The Paging Library makes it easier for you to load data gradually and gracefully within your app's List.

Code Analyze Tools

• SwiftLint - A tool to enforce Swift style and conventions.

🚀 Posts In Medium

Article

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Open an issue first to discuss what you would like to change.
2. Fork the Project
3. Create your feature branch (git checkout -b feature/amazing-feature)
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a pull request

Please make sure to update tests as appropriate.

✍️ Authors

👤 developersancho

Feel free to ping me 😉

License

Copyright © 2022 - developersancho

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

   http://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.