coco
102 lines
5.5 KiB
Markdown
102 lines
5.5 KiB
Markdown
|
|
|
|
|
|
<a href="https://ktlint.github.io/"><img src="https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg" alt="ktlint"></a>
|
|
[](https://codebeat.co/projects/github-com-igorescodro-alkaa-main)
|
|
[](https://www.codefactor.io/repository/github/igorescodro/alkaa/overview/main)
|
|
[](https://www.codacy.com/manual/igorescodro/alkaa?utm_source=github.com&utm_medium=referral&utm_content=igorescodro/alkaa&utm_campaign=Badge_Grade)
|
|
|
|
<img src="app/src/main/ic_launcher-web.png" width="200">
|
|
|
|
# Alkaa 2.0
|
|
|
|
Alkaa (_begin_, _start_ in Finnish) is a to-do application project to study the latest components,
|
|
architecture and tools for Android development. The project evolved a lot since the beginning is
|
|
available on Google Play! :heart:
|
|
|
|
The current version of Alkaa was also completely migrate to **Jetpack Compose**!
|
|
|
|
<img src="https://play-lh.googleusercontent.com/W76J3O4OvtqiBvGePEL2Czt_Jl52SIcm38SK2m7Jzbq83RdzvDStd1Qn5NoAp3ffEibn=w5120-h2880-rw" width="186"> <img src="https://play-lh.googleusercontent.com/CRRgxRGMLXykBlehra9LNOmCedbAhRjAEbU5QFx0hTXpE6m4P6YXoRv78rd5T22-LEA=w5120-h2880-rw" width="186"> <img src="https://play-lh.googleusercontent.com/XYlsapSwCTNFPNZmFRI9-e5Joc9h5ZprpU8X_eA8Gpcwm2E2ZLOWc7kNi028UoZR0N8=w5120-h2880-rw" width="186"> <img src="https://play-lh.googleusercontent.com/XBjXPeuFkG_lhrbH392LD_wACYpPx69aRP4W2h2oxlvmDYwXDK2ZSEQXGl6pyo-jTfaX=w5120-h2880-rw" width="186">
|
|
|
|
## 📦 Download
|
|
|
|
<a href='https://play.google.com/store/apps/details?id=com.escodro.alkaa'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png' width=240/></a>
|
|
|
|
## 📚 Android tech stack
|
|
|
|
One of the main goals of Alkaa is too use all the latest libraries and tools available.
|
|
|
|
### 🧑🏻💻 Android development
|
|
|
|
- Application entirely written in [Kotlin](https://kotlinlang.org)
|
|
- Complete migrated to [Jetpack Compose](https://developer.android.com/jetpack/compose)
|
|
- Following the [Material You](https://m3.material.io/) guidelines and dynamic color
|
|
- Asynchronous processing using [Coroutines](https://kotlin.github.io/kotlinx.coroutines/)
|
|
- [Dynamic delivery](https://developer.android.com/guide/playcore/feature-delivery) for the _Task
|
|
Tracker_ feature
|
|
- Widgets using [Jetpack Glance](https://developer.android.com/jetpack/androidx/releases/glance)
|
|
- Dependency injection with [Koin](https://insert-koin.io)
|
|
- Database using [Room](https://developer.android.com/topic/libraries/architecture/room)
|
|
|
|
For more dependencies used in project, please access the
|
|
[Dependency File](https://github.com/igorescodro/alkaa/blob/main/gradle/libs.versions.toml)
|
|
|
|
If you want to check the previous version of Alkaa, please take a look at
|
|
the [last V1 release](https://github.com/igorescodro/alkaa/tree/v1.7.0)
|
|
|
|
### 🧪 Quality
|
|
|
|
- [klint](https://github.com/shyiko/ktlint)
|
|
- [detekt](https://github.com/arturbosch/detekt)
|
|
- [compose-rules](https://github.com/twitter/compose-rules)
|
|
- [lint](https://developer.android.com/studio/write/lint)
|
|
- [codebeat](https://codebeat.co)
|
|
- [CodeFactor](https://www.codefactor.io/)
|
|
- [Codacy](http://codacy.com)
|
|
|
|
## 🏛 Architecture
|
|
|
|
Alkaa architecture is strongly based on
|
|
the [Hexagonal Architecture](https://alistair.cockburn.us/hexagonal-architecture/) by Alistair
|
|
Cockburn. The application also relies heavily in modularization for better separation of concerns
|
|
and encapsulation.
|
|
|
|
Let's take a look in each major module of the application:
|
|
|
|
* **app** - The Application module. It contains all the initialization logic for the Android
|
|
environment and starts the _Jetpack Navigation Compose Graph_.
|
|
* **features** - The module/folder containing all the features (visual or not) from the application
|
|
* **domain** - The modules containing the most important part of the application: the business
|
|
logic. This module depends only on itself and all interaction it does is via _dependency
|
|
inversion_.
|
|
* **data** - The module containing the data (local, remote, light etc) from the app.
|
|
* **libraries** - The module with useful small libraries for the project, such as design system,
|
|
* navigation, test etc.
|
|
|
|
This type of architecture protects the most important modules in the app. To achieve this, all the
|
|
dependency points to the center, and the modules are organized in a way that
|
|
_the more the module is in the center, more important it is_.
|
|
|
|
To better represents the idea behind the modules, here is a architecture image representing the flow
|
|
of dependency:
|
|
|
|
|
|
|
|
## 📃 License
|
|
|
|
```
|
|
Copyright 2018 Igor Escodro
|
|
|
|
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.
|
|
```
|