Personal Tracker

A full-stack web application for personal expense tracking and management. This project helps users monitor their spending habits, categorize expenses, and gain insights into their financial data.

Project Overview

The Personal Tracker consists of two main components:

• Backend: Node.js API server handling authentication, data management, and business logic
• Frontend: React-based user interface for interacting with the application

Features

• User registration and authentication
• Email verification and password reset
• Expense tracking with categories
• Dashboard with spending insights
• Responsive design with dark theme
• Secure API with JWT authentication

Tech Stack

Backend

• Node.js & Express.js
• MongoDB with Mongoose
• JWT for authentication
• Email services with Nodemailer
• Security middleware (Helmet, CORS, rate limiting)

Frontend (Planned)

• React.js
• React Router for navigation
• Modern UI with dark theme
• API integration with backend

Getting Started

Prerequisites

• Node.js (v14 or higher)
• MongoDB database
• Git

Installation

1. Clone the repository:

   git clone https://github.com/GoluScriptMage/personal-tracker.git
   cd personal-tracker

2. Set up the backend:

   cd Backend
   npm install
   # Configure environment variables in .env
   npm start

3. Set up the frontend (when implemented):

   cd ../Frontend
   npm install
   npm start

Project Structure

personal-tracker/
├── Backend/          # Node.js API server
│   ├── controllers/  # Route handlers
│   ├── Models/       # Database models
│   ├── routes/       # API endpoints
│   ├── utils/        # Helper functions
│   └── README.md     # Backend documentation
├── Frontend/         # React application (planned)
└── README.md         # This file

API Documentation

For detailed API documentation, see the Backend README.

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Roadmap

• Backend API with authentication
• Expense management system
• Frontend React application
• Dashboard with charts and analytics
• Mobile-responsive design
• Export functionality for expenses

License

This project is licensed under the ISC License - see the LICENSE file for details.

Contact

For questions or suggestions, please open an issue on GitHub.