https://github.com/akshay2211/paper
A minimal notes application in Jetpack Compose with MVVM architecture. Built with components like DataStore, Coroutines, ViewModel, LiveData, Room, Navigation-Compose, Coil, koin etc.
https://github.com/akshay2211/paper
android android-application dark-theme hacktoberfest hacktoberfest2022 jetpack-android jetpack-compose localstorage notes-app stateflow
Last synced: 4 months ago
JSON representation
A minimal notes application in Jetpack Compose with MVVM architecture. Built with components like DataStore, Coroutines, ViewModel, LiveData, Room, Navigation-Compose, Coil, koin etc.
- Host: GitHub
- URL: https://github.com/akshay2211/paper
- Owner: akshay2211
- License: apache-2.0
- Created: 2019-01-13T18:32:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T18:24:44.000Z (over 2 years ago)
- Last Synced: 2024-10-29T20:20:18.297Z (6 months ago)
- Topics: android, android-application, dark-theme, hacktoberfest, hacktoberfest2022, jetpack-android, jetpack-compose, localstorage, notes-app, stateflow
- Language: Kotlin
- Homepage: https://ak1.io/Paper/
- Size: 3.77 MB
- Stars: 176
- Watchers: 6
- Forks: 26
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Paper - A Minimal Notes App
[](https://androidweekly.net/issues/issue-496)
[](https://play.google.com/store/apps/details?id=io.ak1.paper)
[](https://android-arsenal.com/details/3/8296)
A minimal notes application in [Jetpack Compose](https://developer.android.com/jetpack/compose) with [MVVM architecture](https://developer.android.com/jetpack/guide).
Built with components like DataStore, Coroutines, ViewModel, Flow-State, Room, Navigation-Compose, Coil, koin etc.
#### This App showcases:
* UI state management
* Basic Material Design theming (Light & Dark)
* Integration with Architecture Components: Navigation, ViewModel, Room
* Minor features like dedicated settings screen, Dialogs etc.
This is the first step for [Paper](https://github.com/akshay2211/paper) in becoming a full fledged Notes application with all the desired features
currently this is the first phase which included a basic working good Ui App.
Screenshots
-----------
Flow
-----------
```mermaid
stateDiagram-v2
[*] --> HomeScreen
HomeScreen --> NoteScreen
NoteScreen --> Add
Add --> DoodleScreen
Add --> ImageScreen
NoteScreen --> HomeScreen
NoteScreen --> PreviewScreen
PreviewScreen --> Edit
PreviewScreen --> Delete
Edit --> DoodleScreen
Delete --> DoodleScreen
Delete --> ImageScreen
PreviewScreen --> ImageScreen
HomeScreen --> SearchScreen
SearchScreen --> NoteScreen
HomeScreen --> SettingScreen
HomeScreen --> [*]
```
Completed
-----------
#### Phase 1
* Minimal todo app
#### Phase 2
* Image Integrations
* Doodle Screen Integration
On-going Features
-----------
#### Phase 3
* Material 2 to Material 3 migration
Upcoming Features
-----------
#### Phase 4
* Feature to Share Notes
* Backup and Restore Feature
##### Phase 5
* To-do list integration
* Tags/Folders to segregate notes
Thanks to
----------
[DrawBox](https://github.com/akshay2211/DrawBox) for providing ability to created dynamic doodles on canvas.
Contribute
----------
Interested in seeing a particular feature of the Android Framework or Jetpack implemented in this
app?
Please open a new [issue](https://github.com/akshay2211/paper/issues).
License
-----------------
Licensed under the Apache License, Version 2.0, [click here for the full license](/LICENSE).
Author & support
-----------------
This project was created by [Akshay Sharma](https://akshay2211.github.io/).
If this project help you reduce time to develop, you can give me a cup of coffee :)
[](https://www.paypal.me/akshay2211)