ishansingh1010 / expense-tracker

Welcome to the Expense Tracker . It is a Project where user can track their daily base expenses

Expense Tracker Project Documentation

Welcome to the documentation for the Expense Tracker project built using Node.js. This documentation will guide you through the various features and functionalities of the project.

Table of Contents

1. Introduction
2. Installation
3. Usage
   • User Registration
   • User Login
   • Forgot Password
   • Set New Password
   • Edit Profile
   • Expense Management
     • Add Expense
     • Edit Expense
     • Delete Expense
     • Search Expenses
   • Category Management
     • Create Category
   • Expense Reminder
4. Middleware
5. Logger
6. Validation
7. Conclusion

1. Introduction

The Expense Tracker project is designed to help users manage their expenses effectively. It provides features for user registration, login, password management, expense tracking, category creation, and expense reminders. The project is built using Node.js and incorporates middleware for enhanced security, a logger for efficient debugging, and validation to ensure data integrity.

2. Installation

1. Clone the repository: git clone https://github.com/ishansingh1010/Expense-Tracker
2. Navigate to the project directory: cd expense-tracker
3. Install dependencies: npm install
4. Configure environment variables (e.g., database connection, email service credentials).
5. Start the application: npm start

3. Usage

User Registration

Users can create an account by providing necessary information such as name, email, and password.

User Login

Users can log in using their registered email and password.

Forgot Password

Users who forget their passwords can initiate a password reset process. An email will be sent to their registered email address with a reset link.

Set New Password

After clicking the reset link from the email, users can set a new password for their account.

Edit Profile

Users can modify their profile details like name, email, and password.

Expense Management

Add Expense

Users can add details of a new expense including the amount, date, category, and description.

Edit Expense

Users can edit details of an existing expense, such as updating the amount, date, category, or description.

Delete Expense

Users can delete a specific expense entry.

Search Expenses

Users can search for expenses based on date, category, and expense name.

Category Management

Create Category

Users can create categories to better organize their expenses.

Expense Reminder

Users can set reminders for expenses, and the system will send reminder emails at specified intervals.

4. Middleware

Middleware functions have been implemented to enhance security and manage user sessions.

5. Logger

A logging mechanism is integrated to track application activities and assist in debugging.

6. Validation

Input data is validated to ensure accuracy and prevent malicious inputs from compromising the system.

7. Conclusion

The Expense Tracker project provides users with a comprehensive platform to manage their expenses efficiently. With features such as user registration, expense tracking, password management, and reminders, this project serves as a useful tool for personal finance management.