'Clean Notes' is a simple note-taking 📝 android application built to describe the use of Jetpack Compose with Clean Architecture Design pattern in Android development. Made with love ❤️ by HabbashMahmood
'Clean Notes' is written in with Clean Architecture Design pattern.
Some other technologies used in this project:
- Kotlin - First class and official programming language for Android development.
- Coroutines - For asynchronous and more..
- Hilt - Hilt provides a standard way to incorporate Dagger dependency injection into an Android application.
- Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
- Jetpack Compose - Jetpack Compose is Android’s modern toolkit for building native UI. It simplifies and accelerates UI development on Android. Quickly bring your app to life with less code, powerful tools, and intuitive Kotlin APIs.
- Stateflow - StateFlow is a state-holder observable flow that emits the current and new state updates to its collectors.
- Flow - A flow is an asynchronous version of a Sequence, a type of collection whose values are lazily produced.
- ViewModel - Stores UI-related data that isn't destroyed on UI changes.
- Room - SQLite object mapping library.
- Jetpack Navigation - Navigation refers to the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app
- Material Components for Android - Modular and customizable Material Design UI components for Android.
com.habbashmahmood.clean_note_app/ # Main Package
├───core
│ ├───presentation
│ │ ├───components
│ │ └───util
│ └───setup
│ └───navigation
├───di
├───feature_note
│ ├───data
│ │ ├───data_source
│ │ └───repository
│ ├───domain
│ │ ├───model
│ │ ├───repository
│ │ ├───use_case
│ │ └───util
│ └───presentation
│ ├───add_edit_note
│ │ └───components
│ ├───notes
│ │ └───components
│ └───search_note
│ └───components
├───feature_settings
│ └───presentation
│ └───components
└───ui
└───theme
'Clean Notes' is written in with Clean Architecture Design pattern.
- Light/dark mode toggle
- Fullscreen mode
- No permissions required
- Support for Lollipop devices and up
- Color notes for quick organisation
- Filter notes on basis of Title, Date and Color
- Order notes by Ascending and Decending Order
- Simple minimilistic design
- Auto save
- Pin notes to always keep them at the top
- Label notes for quick organisation
- Archive notes to keep them around, but out of your way
- Export notes as TXT, XML, JSON, HTML or PDF files with formatting
- Create rich text notes with support for bold, italics, mono space and strike-through
- Add clickable links to notes with support for phone numbers, email addresses and web urls
- Search notes
- Settings screen
Have an project? DM us at 👇
Drop a mail to:- [email protected]
If you have any feedback, please reach out to us at [email protected]
MIT License
Copyright (c) 2022 Habbash Mahmood
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.