Expense Tracker

Overview

The Expense Tracker application allows users to manage their expenses and view them in a dashboard with visual representations using charts. It includes functionality for user registration, login, and expense management.

Table of Contents

1. Prerequisites
2. Installation
3. Configuration
4. Running the Application
5. Endpoints
6. Troubleshooting
7. License

Prerequisites

• Node.js: Download and install Node.js
• MySQL: Download and install MySQL
• npm: Comes with Node.js installation

Installation

1. Clone the Repository git clone cd

2. Install Dependencies

   Install the necessary Node.js modules:

   npm install

3. Set Up the Database

   • Ensure MySQL is installed and running.
   • Create a new database for the application or use an existing one. Create db and add tables as follows:

CREATE SCHEMA schema_name;

-- Create the 'categories' table if it does not already exist CREATE TABLE IF NOT EXISTS categories ( id INT AUTO_INCREMENT PRIMARY KEY, name VARCHAR(255) UNIQUE NOT NULL );

-- Create the 'users' table if it does not already exist CREATE TABLE IF NOT EXISTS users ( id INT AUTO_INCREMENT PRIMARY KEY, email VARCHAR(255) UNIQUE NOT NULL, username VARCHAR(255) UNIQUE NOT NULL, password VARCHAR(255) NOT NULL, createdAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP );

-- Create the 'expenses' table if it does not already exist CREATE TABLE IF NOT EXISTS expenses ( id INT AUTO_INCREMENT PRIMARY KEY, userId INT, categoryId INT, amount DECIMAL(10, 2), date DATE createdAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (userId) REFERENCES users(id), FOREIGN KEY (categoryId) REFERENCES categories(id) );

Database Configuration:

• Copy the example environment file and update the database credentials:

• Edit .env file with your database credentials:

  DATABASE_HOST=host DATABASE_USER=user DATABASE_PASSWORD=your_password DATABASE=name SESSION_SECRET=your_session_secret

• Create the database and tables by running the SQL commands provided.

Configuration

1. Environment Variables

   The application relies on environment variables for configuration. Ensure you have a .env file in the root directory with the following variables:

   DATABASE_HOST=your_database_host DATABASE_USER=your_database_user DATABASE_PASSWORD=your_database_password DATABASE=your_database_name SESSION_SECRET=your_session_secret

2. Static Files

Place your static HTML, CSS, and JavaScript files in the public directory. Ensure that home.html, login.html, register.html, and dashboard.html are present.

Running the Application

1. Start the Server

   Run the following command to start the server: npm start

   By default, the server will start on [http://localhost:3000].

2. Access the Application

   • Home Page: http://localhost:3000/
   • Login Page: http://localhost:3000/login
   • Registration Page: http://localhost:3000/register
   • Dashboard Page: http://localhost:3000/dashboard

Endpoints

• POST /api/login: Authenticate a user and start a session.
• POST /api/register: Register a new user.
• POST/api/expense: Add a new expense.
• DELETE /api/expense/:id: Delete an existing expense.
• GET /api/categories: Fetch all expense categories.
• POST /api/logout: Log out the current user.

Troubleshooting

• 404 Errors: Ensure the path in your HTML links is correct. They should point to the root (e.g., Home).
• Database Connection Issues: Verify your .env file for correct database credentials and ensure MySQL is running.
• Session Issues: Check if cookies are enabled in your browser and ensure the session configuration is correct.

License

This project is licensed under the MIT License. See the LICENSE file for details.