Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

Some readme.md improvements #3085

Merged
merged 4 commits into from
Apr 7, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
nvllz marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,28 @@
| ![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)

Ivy Wallet is a free and open-source **money manager android app**. It's written using **100% Kotlin and Jetpack Compose**. It's designed to help you track your personal finance with ease.
Ivy Wallet is a free and open source **money management android app**. It's written using **100% Kotlin and Jetpack Compose**. It's designed to help you keep track of your personal finances with ease.

Imagine Ivy Wallet as a manual expense tracker that tries to replace the good old spreadsheet for managing your finance.
Think of Ivy Wallet as a manual expense tracker that tries to replace the good old spreadsheet for managing your finances.

**Do you know? Ask yourself.**

1) How much money do I have in total?

2) How much did I spend this month and where?
2) How much did I spend this month and what did I spend it on?

3) How much money can I spend and still reach my financial goals?
3) How much can I spend and still meet my financial goals?

A money manager app can help you answer these questions.
A money management app can help you answer these questions.

Ivy Wallet lacks features but its biggest advantage is its UI/UX, simplicity, and customization. This was recognized in the ["Top/Best Android App in 2021/2022 charts"](https://youtube.com/playlist?list=PLguJN0waG1-eSzKMuFMIULrR3MlqJ3cAE) by the YouTube tech community.
Ivy Wallet may lack some of the features you're looking for, but it truly shines in its user interface and experience, as well as its simplicity and customization options. This was recognized in the ["Top/Best Android App in 2021/2022 charts"](https://youtube.com/playlist?list=PLguJN0waG1-eSzKMuFMIULrR3MlqJ3cAE) by the YouTube tech community.

<a href='https://play.google.com/store/apps/details?id=com.ivy.wallet&utm_source=github&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width="323" height="125"/></a>

> Join our **[private Telegram Community](https://t.me/+ETavgioAvWg4NThk)**.

> To support our free open-source project please give it a star. ⭐
> 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)
> To support our free open source project, please give it a star. ⭐
> This means a lot to us. Thank you so much! [![GitHub Repo stars](https://img.shields.io/github/stars/Ivy-Apps/ivy-wallet?style=social)](https://github.com/Ivy-Apps/ivy-wallet/stargazers)

## Project Requirements

Expand All @@ -56,9 +56,9 @@ Join our Telegram community and drop a message in the "Development" topic.

## Learning Materials

Ivy Wallet is a great place to code and learn. That's why we're also linking great learning materials (books, articles, videos), check them in **[docs/resources 📚](docs/resources/)**.
Ivy Wallet is a great place to code and learn. That's why we also link to great learning materials (books, articles, videos), check them out in **[docs/resources 📚](docs/resources/)**.

Make sure to also check our short **[Developer Guidelines 🏗️](docs/Guidelines.md)** to learn more about the Ivy Wallet's tech side.
Make sure to check out our short **[Developer Guidelines 🏗️](docs/Guidelines.md)** to learn more about the technical side of the Ivy Wallet.

[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Ivy-Apps/ivy-wallet/blob/main/CONTRIBUTING.md)

Expand All @@ -70,15 +70,15 @@ Make sure to also check our short **[Developer Guidelines 🏗️](docs/Guidelin
- 100% [Jetpack Compose](https://developer.android.com/jetpack/compose)
- [Material3 design](https://m3.material.io/) (UI components)
- [Kotlin Coroutines](https://kotlinlang.org/docs/coroutines-overview.html) (structured concurrency)
- [Kotlin Flow](https://kotlinlang.org/docs/flow.html) (reactive datastream)
- [Kotlin Flow](https://kotlinlang.org/docs/flow.html) (reactive data stream)
- [Hilt](https://dagger.dev/hilt/) (DI)
- [ArrowKt](https://arrow-kt.io/) (functional programming)


### Testing
- [JUnit4](https://github.com/junit-team/junit4) (test framework, compatible with Android)
- [Kotest](https://kotest.io/) (unit test assertions)
- [Paparazzi](https://github.com/cashapp/paparazzi) (screneshot testing)
- [Paparazzi](https://github.com/cashapp/paparazzi) (screenshot testing)

### Local Persistence
- [DataStore](https://developer.android.com/topic/libraries/architecture/datastore) (key-value storage)
Expand All @@ -93,7 +93,7 @@ Make sure to also check our short **[Developer Guidelines 🏗️](docs/Guidelin
- [Gradle convention plugins](https://docs.gradle.org/current/samples/sample_convention_plugins.html) (build logic)
- [Gradle version catalogs](https://developer.android.com/build/migrate-to-catalogs) (dependencies versions)
- [Github Actions](https://github.com/Ivy-Apps/ivy-wallet/actions) (CI/CD)
- [Fastlane](https://fastlane.tools/) (uploads the app to the Google PlayStore)
- [Fastlane](https://fastlane.tools/) (uploads the app to the Google Play Store)

### Other
- [Firebase Crashlytics](https://firebase.google.com/products/crashlytics) (stability monitoring)
Expand All @@ -114,13 +114,13 @@ Make sure to also check our short **[Developer Guidelines 🏗️](docs/Guidelin
<br>
<br>

_Note: It may take up to 24h for the [contrib.rocks](https://contrib.rocks/preview?repo=Ivy-Apps%2Fivy-wallet) plugin to update because it's refreshed once a day._
_Note: It may take up to 24 hours for the [contrib.rocks](https://contrib.rocks/preview?repo=Ivy-Apps%2Fivy-wallet) plugin to update._

**P.S.** You'll also be recognized in Ivy Wallet's "Contributors" screen that can be found in the android app. We salute you! 👏
**P.S.** You'll also be recognized in a special "Contributors" section. We salute you! 👏

## Creative Contributors

Folks that helped Ivy Wallet in a non-dev creative way that can't be captured in GitHub.
Folks that helped Ivy Wallet in a non-dev creative ways that can't be captured on GitHub.

### Creative Contributors Wall:

Expand All @@ -135,7 +135,7 @@ Folks that helped Ivy Wallet in a non-dev creative way that can't be captured in
<div align="center">
<img src="https://media.licdn.com/dms/image/D4D03AQGiFQMobe7CmA/profile-displayphoto-shrink_800_800/0/1690718245199?e=1713398400&v=beta&t=HyB9vgPe8lIARkgJCYr3C8gFSpGDFGMdDlMIUnunHAY" width="100px;" alt="Stefan Ilijev - Desinger"/><br>
<strong>Stefan Ilijev</strong><br>
<small>Ivy Wallet's co-founder and designer. Created the <a href="https://www.figma.com/file/kSwIa07jcHEHZXo6rzx7dn/Design-System?node-id=0%3A1&mode=dev">Ivy Wallet design.</a></small>
<small>Co-founder and designer of Ivy Wallet. Created the <a href="https://www.figma.com/file/kSwIa07jcHEHZXo6rzx7dn/Design-System?node-id=0%3A1&mode=dev">Ivy design scheme.</a></small>
<br/>
<br/>
</div>
Expand All @@ -156,9 +156,9 @@ Folks that helped Ivy Wallet in a non-dev creative way that can't be captured in
## Community Projects

> ⚠️ Disclaimer: The community projects listed are independently developed and not affiliated with Ivy Apps Ltd. Consequently, we cannot vouch for their functionality, security or intentions. Your engagement with these projects is solely at your own discretion and risk. Ivy Apps Ltd explicitly disclaims any warranties, express or implied, and shall not be held liable for any damages or losses resulting from the use of these community-developed projects.

>
### [ivy-wallet-web](https://github.com/pratikkabade/ivy-wallet-web) by [Pratik Kabade](https://github.com/pratikkabade)

This project, developed by the community, enables users to conveniently access **Ivy Wallet** through their **web browsers**, ensuring a smooth experience across various platforms.
This community-developed project allows users to conveniently access Ivy Wallet through their **web browsers**, ensuring a smooth experience across multiple platforms.
- [GitHub URL](https://github.com/pratikkabade/ivy-wallet-web)
- [Web app URL](https://ivy-wallet-web.vercel.app/)
4 changes: 2 additions & 2 deletions shared/resources/src/main/res/values/strings.xml
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
<string name="google_signing_in_success">Success!</string>
<string name="login_with_google">Login with Google</string>
<string name="offline_account">Offline account</string>
<string name="sync_data_ivy_cloud">SYNC YOUR DATA ON THE IVY CLOUD</string>
<string name="sync_data_ivy_cloud">SYNC YOUR DATA IN THE IVY CLOUD</string>
<string name="data_integrity_protection_warning">Data integrity and protection aren\'t guaranteed!</string>
<string name="or_enter_with_offline_account">OR ENTER WITH OFFLINE ACCOUNT</string>
<string name="offline_warning">Your data will be saved locally only and won\'t be synced with the cloud. Uninstalling the app or changing your device could result in data loss. You can enable sync later if needed.</string>
Expand Down Expand Up @@ -471,7 +471,7 @@
<string name="try_again">Try again</string>
<string name="one_contribution">1 contribution</string>
<string name="contributions_number">%1$s contributions</string>
<string name="you_can_see_a_piechart">You can see a PieChart for your expenses! Click the Expense card on the top of the dashboard.</string>
<string name="you_can_see_a_piechart">You can see a PieChart for your expenses! Click the Expense card at the top of the dashboard.</string>
<string name="it_looks_like_that_you_are_enjoying">It looks like that you\'re enjoying Ivy Wallet! Feel free join our invite-only Ivy Telegram Community and make our app better :)</string>
<string name="ivy_community">Ivy Community</string>
<string name="join_now">Join now</string>
Expand Down