Skip to content

Commit

Permalink
updated README for import screen
Browse files Browse the repository at this point in the history
  • Loading branch information
Ashish Sharma committed Dec 15, 2023
1 parent 2b51a41 commit 66444f2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 18 deletions.
45 changes: 27 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# kilvish

An app to better manage & track your expenses.
An app to better manage & track your expenses.

- You can create your own tags & tag expenses to get a total value at monthly basis
- You can share the tag with your family member to track shared expenses to avoid double paying. Like paying to newspaper vendor
- You can share the tag with your family member to track shared expenses to avoid double paying. Like paying to newspaper vendor
- Your family member can add expenses to tags (like household) so that you can aggregate & track expense against the tag
- You can recover a shared expense by logging it to Kilvish, create a url & sharing it with a friend who can then pay on the url.
- You can recover a shared expense by logging it to Kilvish, create a url & sharing it with a friend who can then pay on the url.

More details at [kilvish.in](https://kilvish.in)

Expand All @@ -24,14 +24,13 @@ More details at [kilvish.in](https://kilvish.in)

## Current app screenshots

| **Signup Screen** | **Home Screen** | **Detail Screen** |
|------------------------------------|----------------------------------|----------------------------------|
| ![](screenshots/signup-screen.png) | ![](screenshots/home-screen.png) |![](screenshots/detail_screen.gif)|

| **Tags Screen** |
|----------------------------------|
| ![](screenshots/tags-screen.png) |
| **Signup Screen** | **Home Screen** | **Detail Screen** |
| ---------------------------------- | -------------------------------- | ---------------------------------- |
| ![](screenshots/signup-screen.png) | ![](screenshots/home-screen.png) | ![](screenshots/detail_screen.gif) |

| **Tags Screen** | **Import Expense Screen** |
| -------------------------------- | ------------------------------------------ |
| ![](screenshots/tags-screen.png) | ![](screenshots/import-expense-screen.png) |

What we aiming to achieve (in high resolution) [here](https://app.moqups.com/4J1cgkPSrhVkHQJhlKViEu4fKGFXatNp/view/page/ae8fe8eb0?ui=0&fit_width=1)

Expand All @@ -40,29 +39,39 @@ What we aiming to achieve (in high resolution) [here](https://app.moqups.com/4J1
We will be putting resources that we referred for someone new to figure out why & how we are doing what, while we build Kilvish

**Signup Page**

- [Learning Layout](https://docs.flutter.dev/development/ui/layout)
- [Learning about Forms](https://docs.flutter.dev/cookbook/forms)

**Package code check**

- [Dart Flutter Package Analyzer](https://github.com/marketplace/actions/dart-flutter-package-analyzer)

**Home Screen**
- [List View without card & spaces](https://codesinsider.com/flutter-listview-example/#ListViewseparated)
- [Time days in past from now](https://stackoverflow.com/questions/61682959/the-date-of-yesterday-in-flutter)
- [show relative dates in past like x days ago](https://pub.dev/packages/jiffy#relative-time)

- [List View without card & spaces](https://codesinsider.com/flutter-listview-example/#ListViewseparated)
- [Time days in past from now](https://stackoverflow.com/questions/61682959/the-date-of-yesterday-in-flutter)
- [show relative dates in past like x days ago](https://pub.dev/packages/jiffy#relative-time)

**Detail Screen**
- Some complex scrolling/rendering through Sliver [SliverList, SliverappBar & SliverPersistentHeader](https://medium.com/flutter/slivers-demystified-6ff68ab0296f)
- To update monthly aggregate, had to decide between [VisibilityDetector](https://stackoverflow.com/questions/63573632/how-to-get-the-index-number-on-scroll-for-listview-in-flutter) & [ScrollView offset approach](https://github.com/flutter/flutter/issues/19941). Chose latter as it would have less event firing so less chances to slow the UI down
- To update the monthly aggregate widget only with scroll, instead of Stateful widget, found Notifier/Listenable pattern [here](https://api.flutter.dev/flutter/widgets/ValueListenableBuilder-class.html) and implemented the same

- Some complex scrolling/rendering through Sliver [SliverList, SliverappBar & SliverPersistentHeader](https://medium.com/flutter/slivers-demystified-6ff68ab0296f)
- To update monthly aggregate, had to decide between [VisibilityDetector](https://stackoverflow.com/questions/63573632/how-to-get-the-index-number-on-scroll-for-listview-in-flutter) & [ScrollView offset approach](https://github.com/flutter/flutter/issues/19941). Chose latter as it would have less event firing so less chances to slow the UI down
- To update the monthly aggregate widget only with scroll, instead of Stateful widget, found Notifier/Listenable pattern [here](https://api.flutter.dev/flutter/widgets/ValueListenableBuilder-class.html) and implemented the same

**Tag Screen**

- Snehal has created Tags from scratch which was a good starting point. Her blog post [here](https://medium.com/nonstopio/flutter-tags-7410bd6a5835)
- Aligning tags like `float:left` using Wrap [link](https://stackoverflow.com/questions/48051289/how-do-you-align-widgets-like-css-float-with-flutter-ui)
- Rendering tag content using `Richtext` [link](https://www.codegrepper.com/code-examples/javascript/flutter+text+and+suffix+icon+)

**Import Screen**

- contact picker [here](https://pub.dev/packages/fluttercontactpicker/example)
- for image picker [here](https://pub.dev/packages/image_picker)

## Like to contribute ?

We are currently creating screens with hardcoded data. We intend to keep the repository 'always open'. So you can showcase your contribution to potential future employers. The app is developed in Flutter & we are all new to Flutter. But we do pretty intense code reviews. If you look to pick Flutter or knows decent bit of Flutter & would like to contribute, you can join our discord channel from this [Link](https://discord.gg/fhW8AgR9) or simply raise a PR.
We are currently creating screens with hardcoded data. We intend to keep the repository 'always open'. So you can showcase your contribution to potential future employers. The app is developed in Flutter & we are all new to Flutter. But we do pretty intense code reviews. If you look to pick Flutter or knows decent bit of Flutter & would like to contribute, you can join our discord channel from this [Link](https://discord.gg/fhW8AgR9) or simply raise a PR.

P.S. We are avoiding a lot of early refactor to keep us agile & be impactful. So we will avoid a lot of early/pre-mature refactoring.
P.S. We are avoiding a lot of early refactor to keep us agile & be impactful. So we will avoid a lot of early/pre-mature refactoring.
Binary file added screenshots/import-expense-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 66444f2

Please sign in to comment.