Skip to content

Commit 80984e0

Browse files
authored
update readme
1 parent be67b80 commit 80984e0

File tree

1 file changed

+73
-4
lines changed

1 file changed

+73
-4
lines changed

README.md

Lines changed: 73 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,74 @@
1-
# FinTrack
1+
# FinTrack <a href="http://34.131.169.168/">|AMD instance hosted link|</a> <a href="https://youtu.be/GW1fLwpzIvk">|Demo Video|</a>
22
A Web App built for Splitting bill among friends while on a trip.
3-
Also the user can add new trips, add transaction related to that trip. The user can filter all the transactions based on a specific trip or a specific user or both.
4-
Following is the drive link of the ppt, descibing all the features of the app and how to use it.
5-
https://drive.google.com/file/d/1ToIpn5ARSm9cpdmct7M6TuMYlO6rvwg1/view?usp=sharing
3+
4+
# PPT Link showing the IDEA and the SOLUTION - <a href="https://drive.google.com/file/d/1ToIpn5ARSm9cpdmct7M6TuMYlO6rvwg1/view?usp=sharing">View File</a>
5+
6+
# Details about the app
7+
8+
While on a long trip, Splitting bills has always been a headache, be it at a restaurant, auto fare, Hotel check-ins. It often leads to misunderstandings and
9+
sometimes even to the end of friendship. Fortunately, we live in a digital era where technology can solve this problem for us. With this we got the idea of
10+
an app/website for splitting bills among users that can make things easier for all of us.
11+
12+
## How the app works
13+
The app allows you to split bills with your friends, family, or colleagues trip-wise.There is a list of trips in which you can also add new trip.
14+
All you have to do is add the bill details and the number of people involved with the tag of that trip.
15+
The app calculates the split amount automatically and even allows you to split it unevenly in case someone owes more or less amount.
16+
17+
## Features of the app
18+
The app comes with several features that genuinely make it stand out from other apps available in the market.
19+
This website is designed to make it easier to divide up the bill among multiple persons by giving a simple interface for doing so.
20+
The website then determines how much each participant should pay after considering everyone's share.
21+
The website consists of following pages:=
22+
1. Home page:
23+
A. Home page shows Three Cards:
24+
a) Total Expenditure
25+
b) I owe people
26+
c) People owe me
27+
B. It shows different cards for different groups.
28+
For each group, we can see
29+
a) All the transactions related to that group.
30+
b) All the users are involved in that group.
31+
c) Number of days of the trip.
32+
C. We can add new Group.
33+
34+
2. User Page:
35+
A. The user page shows the list of other users with which the user is involved in any transaction.
36+
B. The table shows a list of users with the following information:
37+
a) User: the user with which there ever happened any transactions in any group.
38+
b) Status: It shows whether I've lent the money(Green badge) (or) I have borrowed the money(red badge)
39+
c) Amount: The total amount that is sum total of all the transactions ever happened between me and that user. If borrowed, the amount will be shown negative, red. If lent, the amount will be shown positive, green.
40+
d) Details:By clicking on this button, You got to see all the transactions details where you have involved with that user.
41+
42+
3. Transaction page:
43+
A. The Transaction page shows All the transactions.
44+
a) User who had paid for others.
45+
b) Users who are involved in that transaction.
46+
c) Date and day
47+
d) Status: Pending(Red),Settled(Green)
48+
e) Actions:It shows two Actions:Delete & Settled
49+
B. We can filter the transactions on the following basis:
50+
a) Group-wise filter
51+
b) User-wise filter
52+
c) Group+User- wise filter
53+
C. We can add a new Transaction by clicking on the add button.
54+
55+
4. Community Page: here we can have general communication. We can tag a group or a person while adding post. We can also add a comment and we can delete a post if we want.
56+
57+
58+
## Technical architecture
59+
1. Web App: ReactJS, Firebase
60+
2. API: Firebase (Authentication, Firestore)
61+
3. Google Cloud Platform: AMD instance, Firebase
62+
4. Database: Cloud Firestore
63+
5. Deployment: AMD instance on Google Cloud
64+
65+
## Compatibility of the app
66+
The app is compatible with any web browser. No need of downloading, simply visit the website sign up and start using it for all your bill-splitting needs.
67+
68+
## Security and Privacy
69+
We understand the need for security and therefore the app uses encryption powered by Google Firebase to secure all your sensitive data. Your details are never shared with third-party
70+
applications, and you have to enter userID and password or sign in to access the app, Then only you got to see the details of all the transaction and trip.
71+
72+
## Conclusion
73+
In conclusion, splitting bills with friends, family, or colleagues has never been easier with this app. The app comes loaded with features such as splitting
74+
bills, requesting money, tracking expenses, and monitoring spending patterns. It is secure, user-friendly and can be run on any web browser without downloading. So, next time you go out with friends or family, remember to split your bills with this app!

0 commit comments

Comments
 (0)