HellBus1/VentNote
HellBus1/VentNote has 31 GitHub stars and 1 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-15 17:26 UTC. Last push 2026-11-01.
What you can do
- Minimal & Aesthetic UI: Built entirely with Jetpack Compose Material 3; adapts seamlessly across compact phones, foldables, and tablets.
- Note Pinning: Pin important notes to permanently affix them at the top of your list with priority SQL sorting (is_pinned DESC).
- Tags & Category System: Organize notes using custom colored tags, a 12-color curated palette, and a dashboard horizontal filter chip bar. Notes support up to 3 tags max.
- Rich Text & Markdown Editor: Format notes on the fly with bold, italic, strikethrough, underline, and bulleted/ordered lists.
Measured star growth
- in 24h
- 0
- in 7 days
- Update delayed
- in 15 days
- Update delayed
- in 1 month
- Update delayed
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
VentNote: taking notes like a breeze. A simple note management app build with native kotlin.
ProductivityREADME.md
Original
Taking notes like a breeze.
An intuitive, modern note management Android application built with Jetpack Compose, Clean Architecture, Kotlin Coroutines & Flow, Room SQLite, and Material 3 Design.
📸 Feature Showcase
VentNote delivers an aesthetically pleasing, friction-free note-taking experience with adaptive layouts, vibrant theming, and robust categorization:
![]() Dashboard & Tag Chips Adaptive Staggered Grid, Category Filter Chips, and Quick Pin Button |
![]() Note Editor & Markdown Rich text formatting toolbar, empty title flexibility ("Untitled"), and tag selection |
![]() Note Detail & Reading Rendered Markdown formatting, category badges, and inline editing |
![]() Navigation & Theming Dark/Light mode switch, 4 curated Material 3 color palettes, and tool shortcuts |
![]() Tag & Category Manager 12-color curated palette, duplicate prevention, and cascading deletion |
![]() Google Drive Sync Hidden appDataFolder storage, dual-format restore, and timestamp retention
|
![]() Export, Sharing & Batch Actions Export notes as text/image preview, multi-select marking mode, and batch deletion |
📱 Features
- Minimal & Aesthetic UI: Built entirely with Jetpack Compose Material 3; adapts seamlessly across compact phones, foldables, and tablets.
- Note Pinning: Pin important notes to permanently affix them at the top of your list with priority SQL sorting (
is_pinned DESC). - Tags & Category System: Organize notes using custom colored tags, a 12-color curated palette, and a dashboard horizontal filter chip bar. Notes support up to 3 tags max.
- Rich Text & Markdown Editor: Format notes on the fly with bold, italic, strikethrough, underline, and bulleted/ordered lists.
- Flexible Note Creation: Write notes without requiring a title; automatically displays a graceful, localized
"Untitled"fallback. - Dual View Modes: Seamlessly switch between a clean Linear List and a dynamic Staggered Grid, persisted via AndroidX DataStore.
- Live Search & Dynamic Multi-Sorting: Instant search across titles and body text; sort notes by Updated Date, Created Date, or Title in Ascending/Descending order.
- Multi-Select & Batch Deletion (Marking Mode): Long-press to enter selection mode, select/unselect all, and safely delete multiple notes with modal confirmation.
- Google Drive Cloud Backup & Restore: Securely backup your entire workspace (notes, tags, and cross-references) to your hidden Google Drive
appDataFolder. Restores preserve original historical timestamps and support backward compatibility with legacy Version 0 backups. - Personalization & Dark Mode: Choose between Dark Mode and Light Mode, and personalize your experience with 4 bespoke Material 3 color palettes (Purple, Crimson, Cadmium Green, Cobalt Blue).
- Launcher App Widget: Stay productive with an interactive Android home screen widget showing your latest notes with instant deep-linking.
- Share Preview: Export and share notes with friends and colleagues as formatted text or styled images.
- In-App Updates: Integrated Google Play Core update checks.
📚 Technical Documentation & QA Matrix
Comprehensive architecture guides, feature specifications, and manual test matrices are available in the /docs directory:
- Architecture: System Overview: Clean Architecture, MVVM + MVI Unidirectional Data Flow, reactive pipelines, and Hilt dependency injection.
- Architecture: Database & Persistence: Room SQLite schemas (
NoteModel,TagModel,NoteTagCrossRef), Many-to-Many relations, foreign key cascades, and indexing strategies. - Manual QA Testing Matrix: Production-grade test matrix featuring 47 test cases spanning 10 modules with step-by-step procedures, expected outcomes, and edge-case verifications.
- Feature Deep-Dives:
- Technical Reference & Schemas: JSON backup contracts, Room DAO interfaces, and UI test tags.
🛠 Technology Stack
| Layer | Technologies |
|---|---|
| Language & Concurrency | Kotlin (1.8+), Coroutines, StateFlow / Flow |
| UI Framework | Jetpack Compose with Material 3 |
| Architecture | Modern Android Architecture (Clean Architecture + MVVM + UDF) |
| Dependency Injection | Dagger Hilt |
| Local Database | AndroidX Room (SQLite ORM) |
| Key-Value Storage | AndroidX DataStore Preferences |
| Cloud Storage | Google Drive REST API v3 (via Google Play Services Auth) |
| Markdown Engine | Custom Rich Text & Markdown Parser |
| Testing | AndroidX Compose Test, Espresso, JUnit 4, Hilt Android Testing |
📥 Installation & Getting Started
Prerequisites
- Android Studio Hedgehog or newer
- Android SDK 34
- JDK 17 (recommended: Android Studio bundled JBR)
- Physical device or Emulator running Android 5.1 (API 22) or higher
Building from Source
# 1. Clone the repository
git clone https://github.com/HellBus1/VentNote.git
cd VentNote
# 2. Checkout the latest branch
git checkout staging
# 3. Build debug APK
./gradlew assembleDebug
# 4. Install onto connected Android device
adb install -r app/build/outputs/apk/debug/app-debug.apk
Running Tests
# Run unit tests
./gradlew testDebugUnitTest
# Run instrumented integration tests (requires connected emulator/device)
./gradlew connectedDebugAndroidTest
🤝 Contribution Guide
Contributions are welcome! Please follow these steps:
- Fork the repository and clone your fork locally.
- Create a feature branch from
staging(e.g.,git checkout -b feature/awesome-feature). - Make your improvements, ensuring code conforms to project architecture and existing tests pass.
- Push to your fork and submit a Pull Request targeting the
stagingbranch.
☕ Support the Project
If you find VentNote helpful or use it as reference for modern Android development with Jetpack Compose, please consider leaving a star ⭐️ or supporting development:
📄 License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.






