Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bfpimentel/counters-app
Counters Android App and Node Server following the offline-first way to do things, using the latest APIs and best practices with asynchronous communications and unobstrusive sync.
https://github.com/bfpimentel/counters-app
android kotlin
Last synced: 12 days ago
JSON representation
Counters Android App and Node Server following the offline-first way to do things, using the latest APIs and best practices with asynchronous communications and unobstrusive sync.
- Host: GitHub
- URL: https://github.com/bfpimentel/counters-app
- Owner: bfpimentel
- Created: 2021-04-14T21:05:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-28T22:21:31.000Z (over 3 years ago)
- Last Synced: 2024-11-05T09:20:32.587Z (about 2 months ago)
- Topics: android, kotlin
- Language: Kotlin
- Homepage:
- Size: 578 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Counters Android App
Project using the latest Android APIs and best practices, using asynchronous communication with the local database and remote server.
## Some notes
I am not the best UI/UX guy, so I tried to show my architecture, libraries and design pattern knowledge at most of the time.
Each of the features has its on [branch](https://github.com/bfpimentel/counters-app/branches) and almost of them are mapped inside the issue [Feature Roadmap](https://github.com/bfpimentel/counters-app/issues/1). I followed the [**conventional**](https://www.conventionalcommits.org/en/v1.0.0/) [commits messages](https://github.com/bfpimentel/counters-app/commits/develop).
The code coverage tool that I use ([codecov.io](https://codecov.io/)) was not working properly, I couldn't see any coverage reports in the web app, so I tried to cover at least 80% of code looking on the basic report.
## Running the Application
1. Clone repository
2. Start server
```
$ cd server
$ npm install
$ npm start
```
3. Run Android project in Android Studio
## Architecture Explanation
I choose to modularize just the project layers instead of the features because there were just two screens and there are no plans to add more. I focused on ease to maintain and on Clean Architecture principles.
This is a representation of the architecture, the connection between UseCases is not obligatory, more details below.
The arrows on the top can be read as "talks to".
### :app
This is the presentation layer, it is responsible for what the user sees.
- **Fragment**: The Fragment is responsible to listen to the user inputs and its ViewModel outputs.
- **ViewModel**: It expects the Fragment inputs and calls the UseCases, from _domain_ module, then, it can output the data to the Fragments via LiveData observers. All the ViewModels in this project also have a Navigator.
- **Navigator**: It navigates or pops to other fragments.
---
### :domain
This is the domain layer, it holds the business rules of the applications and it is a pure java/kotlin module.
- **UseCase**: It is responsible for the business rules on the application, it talks to the repositories by dependency inversion or to another use cases.
---
### :data
This is the data layer, it does not contain any business rules, it is responsible to get data from local or remote data sources.
- **Repository**: It is just a composition of local or remote data sources, the interfaces on those are from the _domain_ module.
- **DataSource**: It is responsible to talk with the remote server or local database.
## API Endpoints & Examples
```
GET /api/v1/counters
# []
PUT /api/v1/counters/sync
Request Body:
# {
# "deletedCounterIds": [],
# "counters": [
# { "id": "-MZ-CFVG--8LbqVX2LaM", "title": "Cupcakes eaten", "count": 3 }
# ]
# }
Response Body:
# [
# { "id": "-MZ-CFVG--8LbqVX2LaM", "title": "Cupcakes eaten", "count": 3 }
# ]
PUT /api/v1/counters/sync
Request Body:
# {
# "deletedCounterIds": [ "-MZ-CFVG--8LbqVX2LaM" ],
# "counters": [
# { "id": "-MZ-DTl7e7urGjlsAt3X", "title": "Tequila shots", "count": 30 }
# ]
# }
Response Body:
# [
# { "id": "-MZ-DTl7e7urGjlsAt3X", "title": "Tequila shots", "count": 30 }
# ]
```