From ca3c4ac5d14229e09858bd4c725caa7280c4f289 Mon Sep 17 00:00:00 2001 From: ILIYANGERMANOV Date: Fri, 25 Aug 2023 17:11:04 +0300 Subject: [PATCH] Update the README and improve the Telegram bot (#2506) * Improve the "APK" telegram bot message * Update README.md * Update README.md * Update README.md * Update README.md --- .github/workflows/apk.yml | 2 +- README.md | 178 +++++++++++--------------------------- 2 files changed, 50 insertions(+), 130 deletions(-) diff --git a/.github/workflows/apk.yml b/.github/workflows/apk.yml index fad27bf0ef..cf60613a3e 100644 --- a/.github/workflows/apk.yml +++ b/.github/workflows/apk.yml @@ -41,7 +41,7 @@ jobs: run: | COMMIT_LINK="https://github.com/${GITHUB_REPOSITORY}/commit/${GITHUB_SHA}" COMMIT_MESSAGE=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" "https://api.github.com/repos/${GITHUB_REPOSITORY}/commits/${GITHUB_SHA}" | jq -r .commit.message) - CAPTION="Ivy Wallet Demo APK built from \"$COMMIT_MESSAGE\" commit: $COMMIT_LINK" + CAPTION="Ivy Wallet Demo APK:\n\n$COMMIT_MESSAGE\n\ncommit: $COMMIT_LINK" curl -F "chat_id=-1001647280565" \ -F "document=@app/build/outputs/apk/demo/app-demo.apk" \ diff --git a/README.md b/README.md index 76ebe286a0..f2479b0e82 100644 --- a/README.md +++ b/README.md @@ -1,159 +1,79 @@ -[![Latest Release](https://img.shields.io/github/v/release/iliyangermanov/ivy-wallet)](https://github.com/ILIYANGERMANOV/ivy-wallet/releases) -[![Lint](https://github.com/ILIYANGERMANOV/ivy-wallet/actions/workflows/lint.yml/badge.svg)](https://github.com/ILIYANGERMANOV/ivy-wallet/actions/workflows/lint.yml) -[![Internal Release](https://github.com/ILIYANGERMANOV/ivy-wallet/actions/workflows/internal_release.yml/badge.svg)](https://github.com/ILIYANGERMANOV/ivy-wallet/actions/workflows/internal_release.yml) +[![Latest Release](https://img.shields.io/github/v/release/Ivy-Apps/ivy-wallet)](https://github.com/Ivy-Apps/ivy-wallet/releases) +[![APK](https://github.com/Ivy-Apps/ivy-wallet/actions/workflows/apk.yml/badge.svg)](https://github.com/Ivy-Apps/ivy-wallet/actions/workflows/apk.yml) +[![Lint](https://github.com/Ivy-Apps/ivy-wallet/actions/workflows/lint.yml/badge.svg)](https://github.com/Ivy-Apps/ivy-wallet/actions/workflows/lint.yml) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/ILIYANGERMANOV/ivy-wallet/blob/main/CONTRIBUTING.md) +[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Ivy-Apps/ivy-wallet/blob/main/CONTRIBUTING.md) +[![Telegram Group](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/+ETavgioAvWg4NThk) +[![GitHub Repo stars](https://img.shields.io/github/stars/Ivy-Apps/ivy-wallet?style=social)](https://github.com/Ivy-Apps/ivy-wallet/stargazers) # [Ivy Wallet: money manager](https://play.google.com/store/apps/details?id=com.ivy.wallet) -## Ideology :earth_africa: +| | | | | +| :---: | :----: | :---: | :---: | +| ![1](https://user-images.githubusercontent.com/5564499/189540998-4d6cdcd3-ab4d-40f7-85d4-c82fe8a017d1.png) | ![2](https://user-images.githubusercontent.com/5564499/189541011-1ebbd8b6-50fe-432a-91e2-59206efe99ce.png) | ![3](https://user-images.githubusercontent.com/5564499/189541023-35e7f163-d639-4466-9a91-c56890d5a28e.png) | ![4](https://user-images.githubusercontent.com/5564499/189541027-d352314c-fd5c-43eb-82ad-4aba14c7b0fa.png) +| ![5](https://user-images.githubusercontent.com/5564499/189541030-1a0d7948-33af-420b-b126-936d0211c93f.png) | ![6](https://user-images.githubusercontent.com/5564499/189541035-621c4511-5ec7-4d3f-b08e-925d8da95472.png) |![7](https://user-images.githubusercontent.com/5564499/189541127-7adf5bfa-0652-461c-80f1-076b7179eb6c.png) | ![8](https://user-images.githubusercontent.com/5564499/189541040-7cab633e-be4c-40b2-a2c6-890a15edf805.png) -We believe that people _(not corporations or business entities)_ can create innovative, open-source, -and free software that can make the world a better place. +Ivy Wallet is a **free money manager android app** written using 100% Jetpack Compose and Kotlin. It's designed to help you track your personal finance with ease. -**We want Ivy to be:** +Imagine Ivy Wallet as a manual expense tracker that will replace the good old spreadsheet for managing your personal finance. -- A place where you can excel and have fun while contributing to something meaningful. -- A community where you can express yourself freely and build the future that you want to live in. -- An open-source project that'll inspire a movement where people can build the software they want - and eventually become a DAO where hundreds of developers can work on their own terms. +Track your expenses, fast and on-the-go! ⚡ Discover powerful insights about your spending. -**We believe in:** +**Do you know? Ask yourself.** -- Freedom. -- Creativity & Innovation. -- Challenging the status quo. -- Decentralization. -- Having the right to do what you believe in, not what you're told to. +1) How much money do I have right now in all accounts combined? -## Community +2) How much did I spend this month and where? -Be the change! Join our [Telegram community](https://t.me/+ETavgioAvWg4NThk), comment on GitHub, and -tell us how we can create a better environment for developers & creators to work together. +3) How much money can I spend and still reach my financial goals? -### [Ivy Telegram Community](https://t.me/+ETavgioAvWg4NThk) +A money manager app can help you answer these questions. -### [Ivy Telegram News](https://t.me/ivywallet) +Ivy Wallet's biggest advantage is its UI/UX, simplicity, and customization which was recognized in the ["Top/Best Android App in 2021/2022 charts"](https://youtube.com/playlist?list=PLguJN0waG1-eSzKMuFMIULrR3MlqJ3cAE) 10+ times by the YouTube tech community. -## Ivy Developer Guidelines +Get it on Google Play -A short and helpful guide on Android Architecture, Functional Reactive Programming (FRP) and Ivy best practices - **[Ivy Developer Guidelines](docs/Developer-Guidelines.md)**. +> To support our free, open-source project please ⭐ star our repo - that means a lot for us! Thank you! [![GitHub Repo stars](https://img.shields.io/github/stars/Ivy-Apps/ivy-wallet?style=social)](https://github.com/Ivy-Apps/ivy-wallet/stargazers) + 🙏 -> Tip: Read it -> make proposals -> make the project better! :rocket: +> Join our **[private Telegram Community](https://t.me/+ETavgioAvWg4NThk)**. -## The Ivy Wallet App - -Personal finance and spending tracker app which helps you manage your money. -
-ivy-wallet-screenshot-1 -ivy-wallet-screenshot-2 -ivy-wallet-screenshot-3 -ivy-wallet-screenshot-4 -ivy-wallet-screenshot-5 -ivy-wallet-screenshot-6 -ivy-wallet-screenshot-7 -ivy-wallet-screenshot-8 -
- -Ivy Wallet is a free budget manager and spending tracker app that’ll help you manage your personal finances with ease. - -Imagine Ivy Wallet as a digital financial notebook (manual expense tracker) in which you’ll track your income, expenses, and budget. - -The advantage that our money manager gives you is that you can track expenses on the go with an intuitive and simple user interface (UI). - -Once your transactions make their way into Ivy Wallet, the spending tracker app will give you insight into your monthly spending and help you plan your budgets. - -When you enter more income and expenses in the money manager app you'll have an answer to three essential questions: - -1) Exactly how much money do I have right now in all accounts combined? (money manager) - -2) How much did I spend this month and where? (expense tracker) - -3) How much money can I spend and still reach my financial goals? (budget manager) - -$Track. $Budget. $Save - -[](https://play.google.com/store/apps/details?id=com.ivy.wallet) +## Project Requirements +- Java 17+ +- The latest **Android Studio Hedgehog** or above (for easy install + use [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/)) -## Design -- **[Design System](https://www.figma.com/file/kSwIa07jcHEHZXo6rzx7dn/Design-System)** -- **[Icon Pack](https://www.figma.com/file/wKAAh6pN7fZmyehHRXxewD/Icon_pack)** -- **[Android App](https://www.figma.com/file/dz45jBNcLJYi0ehMLq7zMO/Android_APP)** +## Tech Stack -_..Migration from Adobe XD to public Figma project IN PROGRESS!_ +### Core +- 100% [Kotlin](https://kotlinlang.org/) +- 100% [Jetpack Compose](https://developer.android.com/jetpack/compose) +- [Kotlin Coroutines](https://kotlinlang.org/docs/coroutines-overview.html) +- [Kotlin Flow](https://kotlinlang.org/docs/flow.html) +- [Hilt](https://dagger.dev/hilt/) (DI) +- [Jetpack Compose Navigation](https://developer.android.com/jetpack/compose/navigation) +- [ArrowKt](https://arrow-kt.io/) (Functional Programming) -## [Documentation](https://github.com/ILIYANGERMANOV/ivy-wallet/wiki) -To understand more about Ivy Wallet and its data model please visit [Ivy Wallet Wiki](https://github.com/ILIYANGERMANOV/ivy-wallet/wiki). +### Local Persistence +- [DataStore](https://developer.android.com/topic/libraries/architecture/datastore) (key-value storage, Shared Preferences replacement) +- [Room DB](https://developer.android.com/training/data-storage/room) (SQLite ORM) -## Technologies -### Core -- Kotlin -- Jetpack Compose (UI & navigation) -- MVVM architecture with LiveData -- Hilt (DI) -- Kotlin Coroutines -- Functional Programming with Arrow ### Networking -- Retrofit (REST API) -- OkHttp 3 (REST client) -- Gson (JSON serialization) -### Local Persistence -- Shared Prefences -- Room DB (SQLite ORM) +- [Ktor Client](https://ktor.io/docs/getting-started-ktor-client.html) (REST client) +- [Gson](https://github.com/google/gson) (JSON serialization) + ### Other -- EventBus (cross component communication) -- Timber (Logging) -- Firebase Crashlytics (crashes, logging) +- [Timber](https://github.com/JakeWharton/timber) (Logging) +- [Firebase Crashlytics](https://firebase.google.com/docs/crashlytics) (crashes, logging) + ### CI/CD -- Gradle KTS -- Fastlane (upload to Google PlayStore) -- Github Actions (CI/CD server) +- [Gradle KTS](https://docs.gradle.org/current/userguide/kotlin_dsl.html) +- [Fastlane](https://fastlane.tools/) (upload to Google PlayStore) +- [Github Actions](https://github.com/Ivy-Apps/ivy-wallet/actions) (CI/CD) -## Project Requirements -- Java 11 -- Android Studio Arctic Fox (for easy download - [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/)) - -## How to build? -1. Clone the repository -2. Open with Android Studio -3. Everything should sync and build automatically -- _If any build problems occurr, please open a new issue including the logs._ - -## Contributors [(see graph)](https://github.com/ILIYANGERMANOV/ivy-wallet/graphs/contributors) -### Why to contribute? -- It's a win-win! -- You'll appear as an Ivy Wallet contributor in our public repo -- You can **include it in your CV/LinkedIn** and show recruiters that you contribute to our app _(counts as +1 released app in the [Google PlayStore](https://play.google.com/store/apps/details?id=com.ivy.wallet))_ -- You'll make Ivy Wallet better -- You can develop the features that you want yourself, the way you want them -- You'll play around and learn cutting-edge technologies -- It's the easiest way to learn [Jetpack Compose](https://developer.android.com/jetpack/compose) in - a production environment -- You can see Android Development Best Practices in 2022 (and also help us improve our code) -- When we merge your first PR - I ([Iliyan Germanov](https://www.linkedin.com/in/iliyan-germanov-3963b5b9/)) will endorse you on - LinkedIn for Android Development and Kotlin -- Personal recommendation on your LinkedIn profile after 10 successfully merged PRs - make sure that - you notify us because we don't count your PRs :) - -### How to contribute? - -Follow our -compact **[Contributors Guide](https://github.com/ILIYANGERMANOV/ivy-wallet/blob/main/CONTRIBUTING.md)** -to begin. - -TL;DR: -- Submit pull requests for bug fixes / code improvements to the `develop` branch -- Implement and submit PRs for opened issues -- Report (or fix) bugs/glitches -- Create new issues to give us ideas and feedback -- [Download Ivy Wallet](https://play.google.com/store/apps/details?id=com.ivy.wallet) and leave us a review - -I hope a lot more profile pictures are going to show up here, soon! - -### Contributors Wall: +## Contributors Wall: