Skip to content

Commit 4fbaa8c

Browse files
authored
Add demo video link and update README content
1 parent 244cbc9 commit 4fbaa8c

File tree

1 file changed

+40
-33
lines changed

1 file changed

+40
-33
lines changed

README.md

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,65 +2,76 @@
22

33
FinanceTracker is an automatic finance tracker designed to help you keep a close eye on your spending habits. By intelligently scraping your messages and providing insightful analytics, FinanceTracker enables you to manage your budget more effectively and make informed financial decisions.
44

5+
## Video Demo
6+
7+
You can watch the demo video here: [FinanceTracker Demo](https://drive.google.com/file/d/1FR_VoDodybCcYW6wbBEGmc9BjhB8ta92/view?usp=sharing)
8+
59
## Features
610

7-
- **Automatic Message Scraping**: Effortlessly track your spending by extracting financial information from messages and transactions.
8-
- **Budget Management**: Set budgets for different categories and get notifications when you are nearing your limits.
9-
- **Spending Insights**: Gain an overview of your spending patterns with visual graphs and analytics.
10-
- **Customizable Alerts**: Receive alerts for unusual spending activity or when bills are due.
11-
- **Data Privacy**: Your data remains secure and private with advanced encryption methods.
11+
* **Automatic Message Scraping**: Effortlessly track your spending by extracting financial information from messages and transactions.
12+
* **Budget Management**: Set budgets for different categories and get notifications when you are nearing your limits.
13+
* **Spending Insights**: Gain an overview of your spending patterns with visual graphs and analytics.
14+
* **Customizable Alerts**: Receive alerts for unusual spending activity or when bills are due.
15+
* **Data Privacy**: Your data remains secure and private with advanced encryption methods.
1216

1317
## Demo Credentials
1418

1519
For a demo of the application, you can use the following credentials:
1620

17-
- **Email**: [email protected]
18-
- **Password**: 123456
19-
- **Website**: [PennyTracker](https://www.pennytracker.tech)
21+
* **Email**: [[email protected]](mailto:[email protected])
22+
* **Password**: 123456
23+
* **Website**: [PennyTracker](https://www.pennytracker.tech)
2024

2125
## Getting Started
2226

2327
Follow these instructions to get the project up and running on your local machine.
2428

2529
### Prerequisites
2630

27-
- **Node.js**: Ensure you have Node.js installed on your system.
28-
- **React.js**: For the front-end of the application.
29-
- **Express.js**: For building the backend.
30-
- **Database**: A suitable database like MongoDB for storing transaction data.
31-
- **Redis**: Used for checking Firebase data.
32-
- **Scraping Library**: Set up the necessary tools for message scraping.
33-
- **AWS SDK**: For interacting with AWS services like S3.
31+
* **Node.js**: Ensure you have Node.js installed on your system.
32+
* **React.js**: For the front-end of the application.
33+
* **Express.js**: For building the backend.
34+
* **Database**: A suitable database like MongoDB for storing transaction data.
35+
* **Redis**: Used for checking Firebase data.
36+
* **Scraping Library**: Set up the necessary tools for message scraping.
37+
* **AWS SDK**: For interacting with AWS services like S3.
3438

3539
### Installation
3640

3741
1. Clone the repository:
42+
3843
```bash
3944
git clone https://github.com/Sridhar1030/FinanceTracker.git
4045

46+
```
4147
2. Navigate to the project directory:
48+
4249
```bash
4350
cd FinanceTracker
4451
```
4552
3. Install dependencies:
53+
4654
```bash
4755
npm install
4856
```
4957
4. Set up your environment variables in a `.env` file. You'll need variables for:
50-
- **Database URL**
51-
- **Redis connection string**
52-
- **Firebase credentials**
53-
- **API keys** (if applicable)
54-
- **Encryption keys** for data security
58+
59+
* **Database URL**
60+
* **Redis connection string**
61+
* **Firebase credentials**
62+
* **API keys** (if applicable)
63+
* **Encryption keys** for data security
5564

5665
### Running the Application
5766

5867
To start the development server, run:
68+
5969
```bash
6070
npm run dev
6171
```
6272

6373
For the production build:
74+
6475
```bash
6576
npm run build
6677
npm start
@@ -75,18 +86,18 @@ npm start
7586

7687
## Technology Stack
7788

78-
- **Frontend**: React.js, Tailwind CSS
79-
- **Backend**: Node.js, Express.js
80-
- **Database**: MongoDB or your preferred database
81-
- **Message Scraping**: Library/tool for scraping messages
82-
- **Caching**: Redis for checking Firebase data
83-
- **Data Visualization**: Chart.js or similar library for graphs and analytics
89+
* **Frontend**: React.js, Tailwind CSS
90+
* **Backend**: Node.js, Express.js
91+
* **Database**: MongoDB or your preferred database
92+
* **Message Scraping**: Library/tool for scraping messages
93+
* **Caching**: Redis for checking Firebase data
94+
* **Data Visualization**: Chart.js or similar library for graphs and analytics
8495

8596
## AWS Services Used
8697

87-
- **AWS EC2**: Deployed the FinanceTracker application on Amazon EC2 for scalable and flexible hosting.
88-
- **AWS S3**: Used Amazon S3 for storing user profile photos securely, enabling easy access and management of user data.
89-
- **AWS SDK**: Integrated the AWS SDK to facilitate interactions with AWS services for file uploads and data retrieval.
98+
* **AWS EC2**: Deployed the FinanceTracker application on Amazon EC2 for scalable and flexible hosting.
99+
* **AWS S3**: Used Amazon S3 for storing user profile photos securely, enabling easy access and management of user data.
100+
* **AWS SDK**: Integrated the AWS SDK to facilitate interactions with AWS services for file uploads and data retrieval.
90101

91102
## Project Structure
92103

@@ -121,7 +132,3 @@ Contributions are welcome! If you have suggestions for improvements or want to f
121132
3. Commit your changes: `git commit -m 'Add new feature'`
122133
4. Push to the branch: `git push origin feature/NewFeature`
123134
5. Open a pull request
124-
125-
## License
126-
127-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

0 commit comments

Comments
 (0)