Skip to content

Commit

Permalink
Updated reame
Browse files Browse the repository at this point in the history
  • Loading branch information
Vinayak Grover committed Apr 9, 2024
1 parent b8287af commit 62021af
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions Src/Components/Readme.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# GharKharch - Personal Expense Management App

## Overview
This React Native app helps users manage their personal expenses efficiently. It includes features such as OTP-enabled phone authentication, creating friends and events lists, tracking expenses, generating reports, and handling UI changes remotely.

## Technologies Used
- React Native
- Firebase
- Google Cloud Platform
- Google Analytics

## Features
- OTP-enabled phone authentication
- Friends and event creation list
- Expense tracking system
- Report generation system
- Remote UI changes handling

## Setup Instructions
1. Clone the repository.
2. Install dependencies using `npm install`.
3. Configure Firebase and Google Analytics with your credentials.
4. Run the app using `npm start`.

## Configuration
- For Firebase setup, update the configuration in `config/firebase.js`.
- For Google Analytics, add your tracking ID in the appropriate file.

## Usage
1. Register or log in using OTP authentication.
2. Create friends and events lists.
3. Track expenses by adding them to the app.
4. Generate reports based on the expenses.
5. Manage UI changes remotely.

## Contributing
We welcome contributions. Please follow the guidelines in CONTRIBUTING.md.

## Contact
For any questions or support, contact us at [email protected]

0 comments on commit 62021af

Please sign in to comment.