Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Aihrarshaikh committed Mar 30, 2023
1 parent 1ebfd47 commit b0a4067
Showing 1 changed file with 106 additions and 10 deletions.
116 changes: 106 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,112 @@
# eclipsis

A new Flutter project.
align = "center">
<img alt="WebBadge" border="0" height='150'src="assets\images\readme2.png" ></img>
<h1 align ="center"><b>Eclipse </b></h1>
</div>

## Getting Started

This project is a starting point for a Flutter application.
<div align = "center">

A few resources to get you started if this is your first Flutter project:
<img src ="https://img.shields.io/badge/Flutter-02569B?style=for-the-badge&logo=flutter&logoColor=white"> </img>
<img src ="https://img.shields.io/badge/firebase-ffca28?style=for-the-badge&logo=firebase&logoColor=black"> </img>

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
</div>

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
<br>
<br>

# Context
Maintaining and keeping track of our income and expenses, investing in the right investment opportunities, and getting ready for the upcoming tax season is important in the current economy. <br>
But according to surveys conducted worldwide, <br>
<ul>
<B>70%</b> of the households struggle with financial insecurity and vulnerability<br>
<B>2/5th</b> of the households in the same class are unable to do any financial savings<br>
<B>only 18%</b> of households tracked their income and expenses on a regular basis<br>
</ul>

To solve this problem we came up with <b>Eclipse</b>
<br>

<div align="center">
<img border="0" src="assets\images\readme1.png" >
</div>
<br>
<b>Eclipse</b> is a Personal Finance app that calculates and generates monthly expense list with advance graphics with <b>SINGLE CLICK</b>, calculates Taxes, provides latest Financial News and showcases best investment opportunities
<br>
<br>
<br>

# Screenshots
<div align="center">
<img border="0" height='350'src="assets\images\readme7.png" >
<img border="0" height='350'src="assets\images\readme3.png" >
<img border="0" height='350'src="assets\images\readme4.png" >
<img border="0" height='350'src="assets\images\readme6.png" >
<img border="0" height='350'src="assets\images\readme5.png" >

</div>


# Features (Available in Light & Dark mode)
### 1. Automated Expenses Tracking
<div >
Say goodbye to manual expense tracking with our automatic expense tracking feature!

Eclipse will generate a monthly expense list for you, making it easy to stay on top of your spending.With a clear picture of where your money is going each month, you'll be able to make more informed decisions about your finances
</div>


### 2. Investment Opportunities
<div>
Looking for a Guaranteed rate of return or the potential for higher returns? We've got you covered.</b>

Eclipse Investing shows you the best investment opportunities in Fixed Deposits and Mutual Funds.

Explore our hand-picked selection and start investing in your financial future today!
</div>


### 3. Latest Financial News
<div>
Stay up-to-date with the latest news from the world of business and technology with our news feature.</b>

Get the latest updates on market trends, economic developments, and technological innovations, all in one place. Swipe through the headlines and read the full stories to stay informed and make informed decisions.
</div>


### 4. Advance Tax Calculation
<div>
Take the guesswork out of your tax calculations with our advanced tax calculator.</b>

Calculate your tax liability, deductions, and credits, so you can plan your finances with confidence.Our intuitive interface makes it easy to enter your information and get accurate results quickly.
</div>
<br>

## Demo

Click [HERE](https://youtu.be/tARwOUoC2u8) to check it out!

## Usage
1. Ensure you have Flutter and Andriod Studio downloaded on your machine and are able to run Flutter projects locally.
2. Run the following command to ensure your system meets the requirements to run the app. All requirements must be met to run the app.
```
flutter doctor
```
3. Git clone the project into the directory of your choosing.
```
git clone https://github.com/TheHarshal30/Eclipse
```
4. Create a Firebase Project, Add an android project and configure Auth and FireStore services on the app for the Website following the official [documents](https://firebase.google.com/docs)

5. Download and Add the google-services.json File and move it inside android/app folder the the cloned repository

6. Run the following commands to download all required dependancies.
```
flutter clean
flutter pub get
```
7. After successfully downloading all dependancies, you are ready to run the app.
```
flutter run --no-sound-null-safety
```
It is preferred you run the app on an actual Andriod device or emulator since it was primarily tested on Andriod; however, iOS will also work.

0 comments on commit b0a4067

Please sign in to comment.