GithubHelp home page GithubHelp logo

posterr's Introduction

Posterr - Rodrigo Calderano Barbacovi

Posterr is a simple project with some resemblance to Twitter but with far fewer features.

Project Structure

This project structure is based on modularization, follows Clean architecture principles and uses MVVM pattern for presentation layer.

Modules

Follows Dependency-Rule from Clean arch, meaning that domain layer is completely agnostic of other modules and feature modules are not dependent on each other.

  • app module: Higher level module that controls DI
  • buildSrc: Controls lib versions
  • core:data: Represents the data layer containing repository implementation, local and remote data sources, dao and network resources
  • core:domain: Kotlin module containing common use cases used by multiple features and repository interfaces
  • core:models: Kotlin module containing common models
  • core:navigation: Containing utility resources for navigation
  • core:ui: Represents the design system, containing ui components, recycler view adapters, view holders and common xml files
  • features:home: Represent the Home Feature, including the presentation layer and some specific domain use cases
  • features:profile: Represent the Profile Feature, including the presentation layer and some specific domain use cases

Automated Tests

  • Instrumented UI tests: Uses Espresso and Robot Pattern. Example can be found on: HomeUiTest
  • Unit tests: Uses MockK and GivenWhenThen Pattern. Example can be found on: AddPostUseCaseImplTest. There are others classes that still need unit test development

Development setup

Require the latest Android Studio to be able to build the app. (Version used to development: Chipmunk)

To run the App you need a device with android API level of 23 or higher

Libraries

Critique

What still need to be improved and developed:

  • Improve UI using a more appropriate design
  • Restructure the post creation feature to a common presentation layer component inside core:ui
  • Implement the rest of unit tests and increase the test coverage

To tackle the app growth, implementing a paging strategy will definitely be needed. One library that could be used is Paging

Still on the app growth thought, Feature Flag and Analytics Tracking strategies would also be appropriate to to collect data and make business decisions.

If the application's code base and development team grows and the build time increases, changing from gradle to buck or bazel should be considered.

To ensure good performance on all devices, the following strategies would help the app to run more optimally:

  • Implement Baseline profiles to improve performance
  • Change koin configuration to use Scopes to load the dependencies only on the flow they are needed
  • Develop new features with [Don't keep activities] options turned on and a memory leak tool to assure correct ram allocation

posterr's People

Contributors

rodrigocalderano avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.