Skip to content

Latest commit

 

History

History
121 lines (85 loc) · 4.34 KB

README.md

File metadata and controls

121 lines (85 loc) · 4.34 KB
Raw

Quack

License Release

Project

TBD

Home Screen Detail Screen

Architecture

The Application built with my architecture library: ⚓️ Anchor.

Anchor

⚓️ Anchor is my functional architecture research project based on Context Receivers. It is developed on top of the well known unidirectional data flow (UDF) design pattern for Compose applications and removes the boilerplate that other UDF patterns required bringing the app state management closes to writing normal Kotlin and reducing complexity to get started.

Anchor's aim is to remove technological questions around Android and allow developers to focus on writing an amazing apps. For this reason Anchor is highly opinionated and tries to remove the most technical decision requirements from the app developers.

ViewModel

ViewModels are managed by Anchor architecture library. Each AnchorScope has it's own ViewModel container where the Scope and running actions are stored and makes sure that configuration changes do not recreate them. Anchor's functionality removes the need for developers to manually create or manage ViewModels and ViewModelFactorys.

Process Death

will be supported by Anchor in a later version.

Functional Clean Architecture

TBD

Modules

TBD

modules graph:

graph TD;
    app-->feature:feed;

    domain:user:api-->network:user;
    domain:user:api-->persistence:user;
    domain:user:api-->platform:domain;
    domain:user:fakes-->domain:user:api;
    
    domain:post:api-->platform:domain;
    domain:post:api-->network:post;
    domain:post:api-->persistence:post;
    domain:post:fakes-->domain:post:api;

    feature:feed-->domain:user:fakes;
    feature:feed-->domain:user:api;
    feature:feed-->domain:post:fakes;
    feature:feed-->domain:post:api;
    feature:feed-->platform:android-database;
    feature:feed-->platform:android-compose;
    feature:feed-->platform:test;

    persistence:user-->platform:database;
    persistence:post-->platform:database;

    network:post-->platform:network;
    network:user-->platform:network;

    platform:domain-->platform:network;
    platform:domain-->platform:database;

    platform:android-database-->platform:database;
Loading

development

To build and run the app locally create a github classic token with read:packages access and provide the key within ~/.gradle/gradle.properties as following:

gpr.user=<github_username>
gpr.key=<github_token>

read more detailed documentation on how to authenticate to Github packages

License

MIT License

Copyright (c) 2023 Karoly Somodi - Kioba

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.