|
5 | 5 | [](https://github.com/flow-mn/flow) |
6 | 6 | [](https://discord.gg/Ndh9VDeZa4) |
7 | 7 |
|
8 | | -## Download Flow (beta) |
| 8 | +## Preface |
9 | 9 |
|
10 | | -[](https://play.google.com/store/apps/details?id=mn.flow.flow) |
11 | | -[](https://apps.apple.com/mn/app/flow-expense-tracker/id6477741670) |
12 | | -[](https://codemagic.io/apps/65950ed30591c25df05b5613/65950ed30591c25df05b5612/latest_build) |
| 10 | + Flow is a |
13 | 11 |
|
14 | | -> Backuping up before updating is highly recommended! |
| 12 | +* Free |
| 13 | +* Open-Source |
| 14 | +* Simple |
| 15 | +* UX-Focused |
| 16 | +* Fully-offline[^1] |
| 17 | +* Cross-platform[^2] |
15 | 18 |
|
16 | | -## Preface |
| 19 | +personal expense tracking app. |
17 | 20 |
|
18 | | -Flow is a free, open-source, cross-platform personal finance tracking app. |
| 21 | +## Download Flow (beta) |
19 | 22 |
|
20 | | -Beta available on Android, iOS, and more[^1] |
| 23 | +[](https://play.google.com/store/apps/details?id=mn.flow.flow) |
| 24 | +[](https://apps.apple.com/mn/app/flow-expense-tracker/id6477741670) |
| 25 | +[](https://github.com/flow-mn/flow/releases/latest) |
21 | 26 |
|
22 | | -### Features |
| 27 | +> You can build and run for Linux and macOS. Haven't tested Windows yet[^2] |
23 | 28 |
|
| 29 | +## Features |
| 30 | + |
| 31 | +* Simple & seamless UX |
24 | 32 | * Multiple accounts |
25 | 33 | * Multiple currencies |
26 | | -* Fully-offline |
| 34 | +* Fully-offline[^1] |
27 | 35 | * Full export/backup |
28 | | - * JSON for backup |
29 | | - * CSV for external software use (i.e., Google Sheets) |
30 | | - |
31 | | -## Try Flow |
| 36 | + * Fully recoverable backups (ZIP/JSON) |
| 37 | + * Export CSV for external software use (i.e., Google Sheets) |
32 | 38 |
|
33 | | -Feedbacks and ideas are greatly appreciated 🌟 |
| 39 | +## Support Flow |
34 | 40 |
|
35 | | -Flow in production: [Blog post](https://blog.gege.mn/publishing-flow-to-production-20250104?showSharer=true) |
| 41 | +Flow is a personal project developed during my free time, and it generates no |
| 42 | +income. Consider helping Flow! Here are some suggestions: |
36 | 43 |
|
37 | | -## Supported platforms |
38 | | - |
39 | | -* Android |
40 | | -* iOS |
41 | | -* and more[^1] |
| 44 | +* Give a star on [GitHub](https://github.com/flow-mn/flow) |
| 45 | +* Leave a review on [Google Play](https://play.google.com/store/apps/details?id=mn.flow.flow) and [App Store](https://apps.apple.com/mn/app/flow-expense-tracker/id6477741670) |
| 46 | +* Tell a friend |
| 47 | +* [Buy me a coffee](https://buymeacoffee.com/sadespresso) |
| 48 | + |
| 49 | + Maintaining Flow on the App Store requires a substantial annual fee |
| 50 | + (see [Apple Developer Program](https://developer.apple.com/support/enrollment/#:~:text=The%20Apple%20Developer%20Program%20annual,in%20local%20currency%20where%20available.)), |
| 51 | + which [I currently cover](https://github.com/sadespresso). To ensure Flow's |
| 52 | + continued existence and future development, your support is greatly appreciated. |
42 | 53 |
|
43 | 54 | ## Development |
44 | 55 |
|
45 | 56 | Please read [Contribuition guide](./CONTRIBUTING.md) before contributing. |
46 | 57 |
|
47 | 58 | ### Prerequisites |
48 | 59 |
|
49 | | -* [Flutter](https://flutter.dev/) (stable) |
| 60 | +* [Flutter](https://flutter.dev/) (latest stable) |
50 | 61 |
|
51 | 62 | Other: |
52 | 63 |
|
53 | | -* JDK 17 if you're gonna build for Android |
| 64 | +* JDK 1.8 or 17 if you're gonna build for Android |
54 | 65 | * [XCode](https://developer.apple.com/xcode/) if you're gonna build for iOS/macOS |
55 | 66 | * To run tests on your machine, see [Testing](#testing) |
56 | 67 |
|
57 | | -Building for Windows, and Linux-based systems requires the same dependencies |
58 | | -as Flutter. Read more on <https://docs.flutter.dev/platform-integration> |
59 | | - |
60 | | -### Running |
61 | | - |
62 | | -`flutter run` |
63 | | - |
64 | | -See more on <https://flutter.dev/> |
| 68 | +Building for Windows, macOS, and Linux-based systems requires the same |
| 69 | +dependencies as Flutter. Read more on <https://docs.flutter.dev/platform-integration> |
65 | 70 |
|
66 | 71 | ### Testing |
67 | 72 |
|
68 | 73 | If you plan to run tests on your machine, ensure you've installed ObjectBox |
69 | 74 | dynamic libraries. |
70 | 75 |
|
71 | | -Install ObjectBox dynamic libraries[^2]: |
| 76 | +Install ObjectBox dynamic libraries[^3]: |
72 | 77 |
|
73 | 78 | `bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-dart/main/install.sh)` |
74 | 79 |
|
75 | 80 | Testing: |
76 | 81 |
|
77 | 82 | `flutter test` |
78 | 83 |
|
79 | | -[^1]: Will be available on macOS, Windows, and Linux-based systems, but no plan |
| 84 | +[^1]: Flow requires internet to download currency exchage rates. Only necessary |
| 85 | +if you use more than one currencies |
| 86 | + |
| 87 | +[^2]: Will be available on macOS, Windows, and Linux-based systems, but no plan |
80 | 88 | to enhance the UI for desktop experience for now. |
81 | 89 |
|
82 | | -[^2]: Please double-check from the official website, may be outdated. Visit |
| 90 | +[^3]: Please double-check from the official website, may be outdated. Visit |
83 | 91 | <https://docs.objectbox.io/getting-started#add-objectbox-to-your-project> |
84 | 92 | (make sure to choose Flutter to see the script). |
0 commit comments