Got it! Here’s a sample README.md
you can use for your repository:
You can see the preview of the app in below link,however the app depends on secured local storage file sharing feature works in apk ,but in pws needed indexeddb.
This Flutter application helps users track their expenses and incomes, providing insights into their financial activities. The app supports adding, viewing, and managing expenses and incomes, all while storing sensitive data securely.
- Expense and Income Tracking: Add and manage both expenses and incomes.
- Secure Storage: Utilizes secured storage to handle sensitive data safely.
- Dynamic Charts: Visualize expenses and incomes using pie charts.
- Date-Based Filtering: Filter and view records by selected dates.
- Detailed View: Access detailed views for each expense and income item.
- Customizable UI: User-friendly interface with customizable themes and options.
To run this application locally, follow these steps:
-
Clone the Repository:
git clone (https://github.com/ShamiLuna/Finance_Tracker.git)
-
Navigate to the Project Directory:
cd Finance_Tracker
-
Install Dependencies:
flutter pub get
-
Run the App:
flutter run
This app uses secured storage to keep sensitive data like expense and income details safe. Ensure that you have configured the necessary environment and dependencies for secured storage to function correctly.
-
Add Expenses/Incomes:
- Use the 'Add Expense' or 'Add Income' buttons to input new records.
- Fill in the required details such as title, amount, date, etc.
-
View Records:
- Browse through the records displayed in the list view.
- Use the dropdowns to filter records by date.
-
Visualize Data:
- View pie charts representing the distribution of expenses or incomes based on categories.
-
Detailed View:
- Tap on any record to view detailed information.
-
Secured Storage Configuration: Ensure you have the necessary keys and configurations for secured storage.
-
Date Formatting: Customize the date format as needed in the
formatDate
method.
To contribute or make changes:
-
Create a New Branch:
git checkout -b feature/your-feature
-
Make Changes and Commit:
git add . git commit -m "Add your message here"
-
Push Changes:
git push origin feature/your-feature
-
Create a Pull Request:
- Navigate to the repository on GitHub.
- Click on 'Pull Requests' and then 'New Pull Request'.
- Select your branch and submit the pull request for review.
This project is licensed under the MIT License - see the LICENSE file for details.