Predict Finance Dashboard

Overview

Predict Finance Dashboard is a comprehensive financial dashboard application that analyzes companies' financial data. This project uses a Machine Learning library to provide predictive insights, helping companies make informed financial decisions.

Table of Contents

• Features
• Technology Stack
• Installation Guide
• Initial Data Setup
• Usage
• Project Structure

Features

• Dashboard Overview: Visualize key financial metrics at a glance.
• Predictive Analytics: Machine Learning library (regression-js) to predict future financial trends.
• Data Visualization: Interactive charts and graphs to visualize financial data.

Technology Stack

Installation Guide

1. Clone the repository:

   git clone https://github.com/iam-harshit/Predict-Finance-Dashboard.git

2. Install backend dependencies:

   cd backend
   npm install

3. Install frontend dependencies:

   cd frontend
   npm install

4. Set up environment variables:
    To properly run the application, you must set up environment variables. Follow these steps:

        1. Create a file named .env in the root directory of the backend.
        2. Add the following environment variables to the .env file:

MONGO_URI=<your-mongodb-uri>
PORT=<port-number>

        3. Create a file named .env.local in the root directory of the frontend.
        4. Add the following environment variables to the .env.local file:

VITE_BASE_URL=<backend-uri e.g. http://localhost:<port-number>>

Initial Data Setup

For the first-time setup, you need to run the following code to populate your database with initial data. This code is located in the index.js file of the backend:

/* ADD DATA ONE TIME ONLY OR AS NEEDED */
// await mongoose.connection.db.dropDatabase();
// KPI.insertMany(kpis);
// Product.insertMany(products);
// Transaction.insertMany(transactions);

Uncomment these lines and run the backend server once to populate the database. After running it, comment the lines again to prevent re-inserting the data.

Usage

1. Start the backend server:

   cd backend
   npm run dev

2. Start the frontend server:

   cd frontend
   npm run dev

Make sure both the frontend and backend servers are running to access the full functionality of the application.

Project Structure

├── Predict-Finance-Dashboard/
├── backend/            # backend code
│   ├── data/
│   ├── models/
│   ├── routes/
│   ├── .env            # Environment variables
│   ├── .gitignore
│   ├── index.js
│   ├── package.json
├── frontend/           # frontend code
│   ├── public/
│   ├── src/
│   ├── .env.local      # Environment variables
│   ├── .gitignore
│   ├── package.json
├── README.md