Skip to content

An Android app to organize your reading list, capture and save highlights.

License

Notifications You must be signed in to change notification settings

sriniketh/prose

Repository files navigation

App icon Prose

Prose is an Android app to capture and save highlights from physical books.

The app uses the Google Play Books API to search for a book and obtain rich content for the same. Books can be saved into a bookshelf and highlights can be added for each saved book. Text recognition is performed on-device using ML Kit.

Saved books and highlights are persisted locally using Room for offline availability.

The app also uses DynamicColors API to align UI colors with the color theme of the wallpaper in both dark and light modes.

Building the project

The project requires a Google Books API key that needs to be added to a apikey.properties file in the core-network module.

The app is setup as a multi-module project containing core and feature modules. It follows the unidirectional data flow model where data flows from the network/database layers to the presentation layer where it's reduced to UI state. This state is then consumed and rendered as UI using Compose.

License

    Copyright 2024 Sriniketh Ramachandran

    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.

About

An Android app to organize your reading list, capture and save highlights.

Topics

Resources

License

Stars

Watchers

Forks

Languages