Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.72 KB

README.md

File metadata and controls

45 lines (34 loc) · 2.72 KB

DocShaper

DocShaper is an open-source Android application that serves as an all-in-one document reader. It supports a variety of document formats including PDF, DOC, DOCX, XLS, PPT, and TXT. DocShaper not only allows you to view these documents but also enables you to share them with a single click. The app is designed to be compatible with Android 10 and above, ensuring it can run on most modern devices.

Features

  • PDF Reader & Editor: Easily open, read, and customize PDF documents. Merge PDFs, add new content, and tailor your documents as needed.
  • Word Reader: View DOC and DOCX files without any hassle.
  • Spreadsheet Viewer: Open and read XLS and XLSX files.
  • PowerPoint Viewer: Access and view PPT files seamlessly.
  • Text Viewer: Open and read TXT files effortlessly.
  • One-Click Sharing: Share documents quickly and easily with just one click.
  • Supports Android 10+: Compatible with devices running Android 10 and above.

Technologies

  • Kotlin - Programming language for Android app development.
  • Jetpack Compose - Declarative UI toolkit for building native Android UIs.
  • Material 3 - UI design system for modern guidelines.
  • Mvi - Modern design pattern for reactive programming.
  • Dagger Hilt - Dependency injection library.
  • Preferences DataStore - New and improved data storage solution, replacing SharedPreferences.

Thanks to the creators and maintainers of the open-source libraries used in this project.

Build

This project is built using Kotlin, Java, and Gradle. Here are the steps to build the project:

Prerequisites

  • Java 8 (1.8)
  • Android Studio Jellyfish | 2024.1.1 or later
  • Android Gradle Plugin 8.5.0 or later
  • Gradle 8.9
  • Minimum SDK 29

Steps

  • Open a terminal and run the following git command: 
    git clone https://github.com/navneetpal01/DocShaper.git
  • Launch Android Studio and choose Open an existing Android Studio project. Navigate to the cloned repository and select the root folder of the project.
  • In Android Studio, click on Build -> Generate Signed Bundle / APK and follow the instructions to generate an APK
  • Alternatively, click ▶ Run and build the app and run it immediately

Contributions

DocShaper is licensed under the MIT License. For more details, see the LICENSE file. We welcome all contributions to the app. Feel free to report any issues and create pull requests for improvements or bug fixes.