Skip to content

Commit 9f3e312

Browse files
authored
Update README.md
1 parent cff0c48 commit 9f3e312

File tree

1 file changed

+108
-1
lines changed

1 file changed

+108
-1
lines changed

README.md

Lines changed: 108 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,108 @@
1-
# Expense_Tracker_SQL
1+
<h1 align="center" id="title">Expense Tracker</h1>
2+
3+
<p align="center"><img src="https://socialify.git.ci/5codeman/Expense_Tracker_SQL/image?custom_description=Tracking+expenses+is+directly+proportional+to+saving+money&amp;description=1&amp;font=KoHo&amp;forks=1&amp;issues=1&amp;language=1&amp;name=1&amp;owner=1&amp;pattern=Brick+Wall&amp;pulls=1&amp;stargazers=1&amp;theme=Dark" alt="project-image"></p>
4+
5+
<p id="description">Expense Tracker SQL is a web-based application that helps users efficiently track and manage their expenses. Built using Node.js Express.js MySQL and Sequelize it allows users to log their expenses categorize them and analyze their spending habits.</p>
6+
7+
<h2>🚀 Demo</h2>
8+
9+
[https://expense-tracker-jvy0.onrender.com/](https://expense-tracker-jvy0.onrender.com/)
10+
11+
12+
13+
<h2>🧐 Features</h2>
14+
15+
Here're some of the project's best features:
16+
17+
* User Authentication: Secure login and registration system.
18+
* Expense Management: Add edit and delete expenses.
19+
* Categories: Categorize expenses by date or category.
20+
* Insights & Reports: View spending trends and summaries by month or date.
21+
* Subscription Payments: Integrated Razorpay for managing subscription payments.
22+
* Password Reset: Uses Bravo for sending password reset emails.
23+
24+
<br>
25+
<h2>🛠️ Installation Steps:</h2>
26+
<p>1. Prerequisites</p>
27+
28+
29+
```
30+
Ensure you have the following installed:
31+
32+
Node.js (v16 or later)
33+
34+
MySQL (latest version)
35+
```
36+
<br>
37+
<p>2. Clone the Repository</p>
38+
39+
```
40+
git clone https://github.com/5codeman/Expense_Tracker_SQL.git
41+
42+
cd Expense_Tracker_SQL
43+
```
44+
<br>
45+
46+
<p>3. Install Dependencies</p>
47+
48+
```
49+
npm install
50+
```
51+
<br>
52+
<p>4. Set Up Database</p>
53+
54+
```
55+
Create a MySQL database.
56+
```
57+
<br>
58+
<p>5. Setup .env file</p>
59+
60+
<p> NOTE: This project is integrated with Razorpay, Brevo and JWT authentication. Before creating the .env file you will need credentials for these services. Generate your own secret key and obtain the necessary Razorpay and Brevo credentials. Refer to the .env format provided below.</p>
61+
62+
```
63+
# Server Configuration
64+
PORT=your_port_number
65+
66+
# Database Configuration
67+
DB_HOST=your_database_host
68+
DB_USER=your_database_user
69+
DB_PASSWORD=your_database_password
70+
DB_SCHEMA=your_database_schema
71+
72+
# API Keys
73+
BREVO_API_KEY=your_brevo_api_key
74+
75+
# Payment Gateway (Razorpay)
76+
RAZORPAY_KEY_ID=your_razorpay_key_id
77+
RAZORPAY_KEY_SECRET=your_razorpay_key_secret
78+
79+
# Security
80+
SECRET_KEY=your_secret_key
81+
82+
```
83+
<br>
84+
<p>6. Start the Application</p>
85+
86+
```
87+
npm start
88+
```
89+
90+
<br>
91+
92+
<h2>💻 Built with</h2>
93+
94+
- **Frontend**: HTML, CSS, JavaScript
95+
- **Backend**: Node.js, Express.js
96+
- **Database**: MySQL with Sequelize ORM
97+
- **Payment Gateway**: Razorpay
98+
- **Email Service**: Brevo
99+
100+
<br>
101+
102+
## Contact
103+
For any queries or feedback, feel free to reach out via GitHub Issues.
104+
105+
106+
---
107+
108+
## Made with ❤️ by [CHIRAG RAJ](https://github.com/5codeman/)

0 commit comments

Comments
 (0)