Skip to content
This repository has been archived by the owner on Aug 18, 2023. It is now read-only.
/ jokeapp-droid Public archive

What? It's an app that gets jokes.

License

Notifications You must be signed in to change notification settings

ryjen/jokeapp-droid

Repository files navigation

jokeapp

a small app to request a joke from iCanHazDadJoke

Archived: focused on skouter as the next evolution.

Random Favorites

analysis

requirements

  • random joke in big font
  • action button to add/remove favourites
  • action button to share joke
  • bottom buttons to sync and view favourites
  • favourites a card list

design

architecture

  • uncle bob's clean architecture in modular android, separation of data, domain and presentation layered cake with use case and mapper icing
  • composable architecture: redux with reducers and effects for state
  • android architecture: viewModels control redux effects and mapping data state to UI state.
  • compose and material ui frameworks
  • kotlin state flow and coroutines: all async state and effects are tied to viewModel scope
  • navigation with routing and notifications
  • per-screen headers and footers
  • data repositories prefer network, and save to local cache

implementation

project layout

To reduce conflicts and complexity while increasing cohesion and loosen coupling.

modules

  • domain: business entities, interfaces and use cases between layers
  • data: implementation of repositories, data storage and mapping to domain
  • ui: presentation of data and user interaction
  • app: the entry point to the application
  • meta: code unspecific to app related to programming languages, frameworks or algorithms
  • test: test data and instrumented tests
  • vendor: third party project files

tests

  • rules and/or injection to handle threading and coroutines
  • fake data generator
  • mocking and mock network server
  • in-memory database
  • user interface tag verifications

maintenance

TODO

  • speech bubbles
  • improve UX (scrolling, snackbar)
  • ML to know sentiment of joke and predict favorites
  • speech bubble characters based on category or sentiment
  • multiplatform (pending kotlin multiplatform release)
    • switch from room to sqldelite
  • abstract to project template
  • generalize content use case, and add new remote sources, like quotes
  • export to text-over-photo for sharing
  • analytics
  • allow user to add content
  • theme switcher
  • device home screen widget
  • splash screen and logo
  • Text-to-speech, laugh track
  • Animations
  • Monetize user customizations
  • security analysis