codereddev / wordup Goto Github PK

StorageUtils should expose methods to

• save files to a defined directory (taken from provider definition in Manifest)
• get a file descriptor for an asset file
• prepare a sound for sharing

As !! is commonly considered as bad code style (although it depends on the situation) the project should be reworked to use better solutions where it's possible.

As described in #2 an image could be used in the UI to describe a category in a menu or the like. This should be an optional part of WordUp.

To give users an easy way to use this framework it should be added to Maven Central.

The framework is currently heavily dependent on WordUpProvider.
This makes customization for developer defined databases really hard as providers are created before application creation, so there is no way to define the custom database in WordUp.init()

To make customization easier WordUpProvider should be replaced by a FileProvider implementation.

To better distinguish between wordup modules the main module should be named wordup-core

For future tests an example app should be build.

This example app will use MVVM as its architecture and will also use Koin for dependency injection.

For now just a simple test environment can be build that will be updated from time to time when new features are implemented.

A lot of WordUp's functions are suspend functions. Although Kotlin Coroutines are a really nice tool for making functions asynchronous it should probably be up to the developer to decide which tool he wants to use.

Therefore WordUp's functions should not rely on Kotlin Coroutines.

The core database scheme from #2 should be implemented. This issue also contains integrating Room.

To give users a more detailed description of how to use WordUp examples apps should be provided for categories and no-categories.

To connect the libraries name with its content Sounds could instead be named Words.

Take another look at coroutines and locks implemented in this repo. Check if they're implemented right.

WordUp will use ExoPlayer for playing sounds. Implement ExoPlayer and expose functions to control it.

WordUp should use a Room SQLite database implementation. Before implementation the scheme of the database should be designed to preserve a precise plan during development.

Plan could be provided hand drawn or by other ways.

https://proandroiddev.com/package-by-type-by-layer-by-feature-vs-package-by-layered-feature-e59921a4dffa

After reading this article I decided to change the packaging of the example app to by-feature.

See StackOverflow for detailed description.