FinSmart

A sleek and intelligent platform for managing personal finances and gaining real-time stock insights. Track expenses, analyze trends, and make informed financial decisions—all in one place!

Table of Contents

• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Features
• Project Structure
• CI/CD
• Contact/Team
• License

About The Project

FinSmart is a user-friendly platform that simplifies personal finance management and stock market analysis. It helps users monitor expenses, gain insights into financial patterns, and stay updated with real-time stock data. Designed for smarter decision-making, FinSmart makes financial planning seamless and efficient.

Built With

This project is built with the following technologies:

• Next.js - React framework for production
• Express.js - Web framework for Node.js
• MongoDB - NoSQL database
• Passport.js - Authentication middleware for Node.js
• Tailwind CSS - A utility-first CSS framework

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You need to have Node.js and npm installed on your machine.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Atreyaa-Subramanya-AVS/FinSmart.git

2. Install NPM packages

   npm install

3. Create a .env file in the root directory and add the following variables:

   MONGO_URI=<your_mongo_uri>
   JWT_SECRET=<your_jwt_secret>
   GOOGLE_CLIENT_ID=<your_google_client_id>
   GOOGLE_CLIENT_SECRET=<your_google_client_secret>
   

Usage

To run the application, you need to run the frontend and backend separately.

To run the backend:

npm start

To run the frontend:

npm run dev

The application will be available at http://localhost:3000.

Features

• Expense Tracking: Monitor your expenses and categorize them to understand your spending habits.
• Financial Analysis: Get insights into your financial patterns with interactive charts and graphs.
• Real-time Stock Data: Stay updated with real-time stock data and make informed investment decisions.
• User Authentication: Secure user authentication with Passport.js and Google OAuth.

Project Structure

The project is structured as follows:

.
├── app
│   ├── dashboard
│   ├── signin
│   └── ...
├── components
│   ├── ui
│   └── ...
├── config
├── demo
├── lib
├── public
├── .gitignore
├── server.js
└── ...

CI/CD

This project is set up with a CI/CD pipeline using GitHub Actions. The pipeline is triggered on every push to the main branch and deploys the application to a production environment.

Contact/Team

• Atreyaa Subramanya AVS - atreyaasubramanya2003@gmail.com

Project Link: https://github.com/Atreyaa-Subramanya-AVS/FinSmart

License

Distributed under the ISC License. See LICENSE for more information.