Skip to content

Commit 0b37d42

Browse files
committed
readme added
1 parent 9469892 commit 0b37d42

2 files changed

Lines changed: 59 additions & 0 deletions

File tree

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Draftly - All-in-One Document Viewer
2+
3+
![Draftly Banner](assets/banner.png)
4+
5+
**Draftly** is a modern and powerful Android application designed to provide a seamless document viewing experience. Whether it's a critical business report, a complex spreadsheet, or a creative presentation, Draftly ensures you can access and view your documents with ease and speed.
6+
7+
## 🚀 Key Features
8+
9+
- **Wide Format Support**: Seamlessly view PDF, Microsoft Word (DOC/DOCX), Excel (XLS/XLSX), and PowerPoint (PPT/PPTX) files.
10+
- **Modern UI/UX**: Built entirely with **Jetpack Compose**, featuring a clean, responsive, and intuitive Material 3 design.
11+
- **High Performance**: Optimized document loading using the **Apache POI** engine for office documents and native PDF rendering.
12+
- **Deep Integration**: Handles document viewing requests from other apps (Email, File Managers, etc.).
13+
- **Recent Files**: Quickly pick up where you left off with a persistent history of recently opened documents.
14+
- **Dark Mode**: A beautiful dark theme that’s easy on the eyes.
15+
- **Privacy Focused**: Works entirely on-device with no external server processing of your documents.
16+
17+
## 🛠️ Tech Stack
18+
19+
- **Language**: [Kotlin](https://kotlinlang.org/)
20+
- **UI Framework**: [Jetpack Compose](https://developer.android.com/jetpack/compose) (Material 3)
21+
- **Architecture**: MVVM (Model-View-ViewModel)
22+
- **Processing Engine**: [Apache POI](https://poi.apache.org/) (for Word, Excel, PPT)
23+
- **Database**: [Room](https://developer.android.com/training/data-storage/room) (for Recent Files)
24+
- **Data Storage**: [DataStore](https://developer.android.com/topic/libraries/architecture/datastore) (for Settings)
25+
- **Image Loading**: [Coil](https://coil-kt.github.io/coil/)
26+
- **Async Operations**: [Kotlin Coroutines](https://kotlinlang.org/docs/coroutines-overview.html) & [Flow](https://kotlinlang.org/docs/flow.html)
27+
28+
## 📦 Getting Started
29+
30+
### Prerequisites
31+
32+
- Android Studio Iguana or newer.
33+
- Android SDK Level 26+.
34+
- Gradle 8.0+.
35+
36+
### Installation
37+
38+
1. Clone the repository:
39+
```bash
40+
git clone https://github.com/yourusername/Draftly.git
41+
```
42+
2. Open the project in **Android Studio**.
43+
3. Sync the project with Gradle files.
44+
4. Run the app on an emulator or a physical device (Minimum SDK 26).
45+
46+
## 📂 Project Structure
47+
48+
- `app/src/main/java/com/docviewer/allinone/`
49+
- `data/`: Repositories, DAOs, and Data Models.
50+
- `ui/`: Compose Screens, ViewModels, and Theme.
51+
- `viewer/`: Document processing logic and viewer factories.
52+
53+
## 📝 License
54+
55+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
56+
57+
---
58+
59+
*Made with ❤️ for a better document viewing experience.*

assets/banner.png

469 KB
Loading

0 commit comments

Comments
 (0)