Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gaffycool/stocksapp
Stocks and Shares app that allows users to search for socks and their prices in their currency and country
https://github.com/gaffycool/stocksapp
Last synced: about 2 months ago
JSON representation
Stocks and Shares app that allows users to search for socks and their prices in their currency and country
- Host: GitHub
- URL: https://github.com/gaffycool/stocksapp
- Owner: gaffycool
- Created: 2024-10-03T14:04:18.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T10:15:31.000Z (3 months ago)
- Last Synced: 2024-11-18T11:43:24.594Z (3 months ago)
- Language: Kotlin
- Homepage:
- Size: 126 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
StocksApp
https://github.com/user-attachments/assets/6582a0ac-fea3-4f74-b0e8-b32be2680aa2
## **stockapp** using Clean Android Architecture
Android App:
- StockApp lists out the Top 50 stocks available with the country and currency, the user can add and remove their favourite stock to their own watch list
- The app also has offline caching via a local db that allows the user to use the device offline to see their favourite stocks.
This repository contains an implementation of a clean architecture for Android applications using Compose, MVVM, Hilt, Coroutines, Kotlin Flow, Repository, Room, Retrofit, Mockk and JUnit.
The project is divided into several modules, including:
- `app`: The main application module, responsible for defining the UI using Compose and coordinating with the presentation layer.
- `commonDomain`: The domain module, responsible for defining the business logic of the application and exposing it through interfaces.
- `interactor`: The Interactors are responsible for call repository functions and do the buisness logics and return required models to viewmodel.
- `commonData`: The data module, responsible for defining the data repository, api services and DTOs.
- `data-repository`: The repository module, responsible for implementing the interfaces defined in the domain module and providing data from both the local and remote data sources.
- `data-local`: The local data source module, responsible for implementing the logic to access data stored locally, using Room as the database.
- `data-remote`: The remote data source module, responsible for implementing the logic to access data from a remote API, using Retrofit as the network client.
Diagram of Stock App Archetecture:
The project follows a layered architecture approach, with each layer (presentation, domain, repository and data) having its own set of responsibilities and being completely decoupled from the other layers. The communication between the layers is done through well-defined interfaces, allowing for easy testing and future modifications.
### Dependencies
Public API:
https://api.twelvedata.com/stocks
[Documentation] - https://twelvedata.com/docs#getting-started
Unit test coverage 100% for VM and repository
Proprietary License: This project is copyrighted and all rights are reserved. No use, redistribution, or modification is permitted without explicit permission.
Copyright (c) 2024-2025 [@GaffyCool]. All rights reserved. This software is proprietary and cannot be used, modified, or redistributed without explicit permission from the author. No warranties are provided, and use of this software is entirely at your own risk.