-
-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5de3583
commit 710f6ee
Showing
1 changed file
with
71 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,71 @@ | ||
| # GreenStash (WIP) | ||
| <p align="center"> | ||
| <a href=""><img width="200" height="200" src="https://github.com/Pool-Of-Tears/GreenStash/blob/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png"></a> | ||
| </p> | ||
| <p align="center" style="font-size:18px"><b>GreenStash</b></p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://www.android.com"><img src="https://forthebadge.com/images/badges/built-for-android.svg"></a> <a href="https://www.github.com/starry69"><img src="https://forthebadge.com/images/badges/built-with-love.svg"/></a> | ||
| </p> | ||
|
|
||
| **GreenStash** is a simple [FOSS](https://en.m.wikipedia.org/wiki/Free_and_open-source_software) android app to help you plan and manage your savings goals easily and establish the habit of saving money. | ||
|
|
||
| ### 🤙 Screenshots | ||
|  | ||
|
|
||
| ### ✨ Features | ||
| - Clean & beautiful UI based on Google's [material design three](https://m3.material.io/) guidelines. | ||
| - Add images to your saving goals to keep you motivated! | ||
| - View how much you need to save daily/weekly/monthly to achieve your goal before deadline. | ||
| - Supports around 100+ local currency symbols. | ||
| - Inbuilt biometric app lock to keep your financial data safe and secure. | ||
| - Fully offline, greenstash doens't require internet permission to work. | ||
| - Compatible with Android 7.0 and above (API 24+) | ||
| - Comes in both light and dark mode. | ||
|
|
||
| ### 🛠️ Built with | ||
| - [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development. | ||
| - [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - To improve performance and overall user experience. | ||
| - [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. | ||
| - [ViewBinding](https://developer.android.com/topic/libraries/view-binding) - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views. | ||
| - [Navigation](https://developer.android.com/guide/navigation) - Navigation component helps you implement navigation, from simple button clicks to more complex patterns, such as app bars and the navigation drawer. | ||
| - [Room database](https://developer.android.com/jetpack/androidx/releases/room) - Persistence library provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite. | ||
| - [Material Components for Android](https://github.com/material-components/material-components-android) - Modular and customizable Material Design UI components for Android. | ||
| - [CuteToast](https://github.com/ahmmedrejowan/CuteToast) - Material Design Custom Toast for Android. | ||
| - [ImagePicker](https://github.com/Dhaval2404/ImagePicker) - Image Picker for Android, Pick an image from Gallery or Capture a new image with Camera. | ||
|
|
||
| ### 🤝 Thanks | ||
| - [Irfansusanto20](https://www.flaticon.com/authors/irfansusanto20) for this awesome app icon. | ||
| - [Sarvesh](https://t.me/NoisYboii) for testing and finding bunch of bugs. | ||
| - [Radcolor](https://github.com/radcolor) for helping me in solving few problems and understanding some concepts. | ||
| - [Pin-069](https://twitter.com/pin_069) for screenshot template design. | ||
| - [Icons8](https://icons8.com/) for vector icons used in about section. | ||
|
|
||
| ### ©️ License | ||
| ``` | ||
| MIT License | ||
| Copyright (c) 2022 Stɑrry Shivɑm | ||
| 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. | ||
| ``` | ||
|
|
||
| Have any suggestions? found a bug? Feel free to create an [issue](https://github.com/Pool-Of-Tears/GreenStash/issues/new) with detailed description. | ||
| <p align="center">Made with ❤ by <a href="https://github.com/starry69">Shivam</a></p> |