coco
113 lines
7.3 KiB
Markdown
113 lines
7.3 KiB
Markdown
<div align="center">
|
||
</br>
|
||
<img src="art/logo_notify.svg" width="200" />
|
||
|
||
</div>
|
||
|
||
<h1 align="center">Notify</h1>
|
||
|
||
</br>
|
||
<p align="center">
|
||
<img alt="API" src="https://img.shields.io/badge/Api%2021+-50f270?logo=android&logoColor=black&style=for-the-badge"/></a>
|
||
<img alt="Kotlin" src="https://img.shields.io/badge/Kotlin-a503fc?logo=kotlin&logoColor=white&style=for-the-badge"/></a>
|
||
<img alt="Jetpack Compose" src="https://img.shields.io/static/v1?style=for-the-badge&message=Jetpack+Compose&color=4285F4&logo=Jetpack+Compose&logoColor=FFFFFF&label="/></a>
|
||
<img alt="material" src="https://custom-icon-badges.demolab.com/badge/material%20you-lightblue?style=for-the-badge&logoColor=333&logo=material-you"/></a>
|
||
</br>
|
||
</br>
|
||
<a href="https://github.com/aritra-tech/Notify/actions">
|
||
<img alt="Build" src="https://img.shields.io/github/actions/workflow/status/aritra-tech/notify/ci_build.yml?label=Build&style=for-the-badge"/></a>
|
||
<img alt="GitHub commits since tagged version (branch)" src="https://img.shields.io/github/commits-since/aritra-tech/Notify/v1.0?color=palegreen&label=Commits&style=for-the-badge">
|
||
<a href="https://github.com/aritra-tech/Notify/stargazers"><img src="https://img.shields.io/github/stars/aritra-tech/Notify?color=ffff00&style=for-the-badge"/></a>
|
||
<a href="https://hits.sh/github.com/aritra-tech/Notify/"><img alt="Hits" src="https://hits.sh/github.com/aritra-tech/Notify.svg?style=for-the-badge&label=Views&extraCount=10&color=54856b"/></a>
|
||
</br>
|
||
<a href="https://github.com/aritra-tech/Notify/releases"><img src="https://img.shields.io/github/downloads/aritra-tech/notify/total?color=orange&style=for-the-badge"/></a>
|
||
<img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/aritra-tech/Notify?style=for-the-badge">
|
||
<a href=""><img src="https://img.shields.io/github/v/release/aritra-tech/notify?color=purple&include_prereleases&logo=github&style=for-the-badge"/></a>
|
||
<a href="https://play.google.com/store/apps/details?id=com.aritra.notify"><img src="https://img.shields.io/endpoint?color=purple&logo=google-play&style=for-the-badge&label=Play%20store&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Dcom.aritra.notify%26l%3DAndroid%26m%3D%24version"/></a>
|
||
</br>
|
||
</p>
|
||
|
||
<h4 align="center">📝Notify is a simple note application that is built with Modern Android development tools.
|
||
This project showcases the Good implementation of Android with proper architecture design.
|
||
Made with ♥ for all Android Developers
|
||
<br>
|
||
<br>
|
||
I’m building it in public. So the idea is for everyone to contribute, leave comments, suggest ideas, etc. using the <a href="https://github.com/aritra-tech/Notify/discussions">Discussions</a> tab.
|
||
<br>
|
||
<br>
|
||
Please go through the <a href="https://github.com/aritra-tech/Notify/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a> file before you start contributing.
|
||
</h4>
|
||
|
||
<div align="center">
|
||
</br>
|
||
<img src="art/notify_banner.svg"/>
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
# ⬇️ Download
|
||
<a href="https://play.google.com/store/apps/details?id=com.aritra.notify"><img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" height=80px />
|
||
<a href="https://github.com/aritra-tech/notify/releases/latest"><img alt="Get it on GitHub" src="https://user-images.githubusercontent.com/69304392/148696068-0cfea65d-b18f-4685-82b5-329a330b1c0d.png" height=80px />
|
||
<a href="https://apt.izzysoft.de/fdroid/index/apk/com.aritra.notify/"><img alt="Get it on izzy" src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" height=80px />
|
||
</div>
|
||
|
||
# Features ✨
|
||
|
||
_Notify_ focuses on the following key things:
|
||
|
||
- Single Activity Design.
|
||
- Offline Capability - Notes. ✈️
|
||
- Clean and Simple Material UI. 🎨
|
||
- Dark mode. 🌗
|
||
- Back/Restore feature. 👀
|
||
- Jetpack Compose UI. 🖌
|
||
- Switch between layouts. 🌟
|
||
- Share the notes in the form of Text, Image & PDF 📤
|
||
|
||
# Built with 🛠
|
||
|
||
- [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development.
|
||
- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - For asynchronous calls and tasks to utilize threads.
|
||
- [Jetpack Compose UI Toolkit](https://developer.android.com/jetpack/compose) - Modern UI development toolkit.
|
||
- [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.
|
||
- [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Data objects that notify views when the underlying database changes.
|
||
- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.
|
||
- [Room](https://developer.android.com/topic/libraries/architecture/room) - Room is an Android library which is an ORM that wraps Android's native SQLite database.
|
||
- [StateFlow and SharedFlow](https://developer.android.com/kotlin/flow/stateflow-and-sharedflow#:~:text=StateFlow%20is%20a%20state%2Dholder,property%20of%20the%20MutableStateFlow%20class.) - StateFlow and SharedFlow are Flow APIs that enable flows to optimally emit state updates and emit values to multiple consumers.
|
||
- [Dependency Injection](https://developer.android.com/training/dependency-injection) -
|
||
- [Hilt-Dagger](https://dagger.dev/hilt/) - A standard way to incorporate Dagger dependency injection into an Android application.
|
||
- [Hilt-ViewModel](https://developer.android.com/training/dependency-injection/hilt-jetpack) - DI for injecting ```ViewModel```.
|
||
- [Material Components for Android](https://github.com/material-components/material-components-android) - Modular and customizable Material Design UI components for Android.
|
||
- [Accompanist](https://google.github.io/accompanist/) - A collection of extension libraries for Jetpack Compose.
|
||
- [Biometric](https://developer.android.com/jetpack/androidx/releases/biometric) - Authenticate with biometrics or device credentials, and perform cryptographic operations.
|
||
- [gson](https://github.com/google/gson) - A Java serialization/deserialization library to convert Java Objects into JSON and back
|
||
- [Coil](https://github.com/coil-kt/coil) - Image loading for Android backed by Kotlin Coroutines.
|
||
- [Telephoto](https://github.com/saket/telephoto) - Building blocks for designing media experiences in Compose UI
|
||
- [Camera X](https://developer.android.com/jetpack/androidx/releases/camera) - CameraX is an addition to Jetpack that makes it easier to add camera capabilities to your app
|
||
|
||
# Architecture 👷♂️
|
||
This app uses [MVVM(Model View View-Model)](https://developer.android.com/topic/architecture#recommended-app-arch) architecture.
|
||
|
||
|
||
|
||
<div align="center">
|
||
|
||
# Contributors 📢
|
||
|
||
<a href="https://github.com/aritra-tech/Notify/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=aritra-tech/Notify" />
|
||
</a>
|
||
|
||
# Star History ⭐
|
||
|
||
[](https://star-history.com/#aritra-tech/Notify&Date)
|
||
|
||
# Find this repository useful? ❤️
|
||
|
||
Support it by joining __[stargazers](https://github.com/aritra-tech/Notify/stargazers)__ for this
|
||
repository. :star: <br>
|
||
And __[follow](https://github.com/aritra-tech)__ me for my next creations! 🤩
|
||
|
||
</div>
|