https://github.com/manaspatil0967/tiaa-surplus

https://github.com/manaspatil0967/tiaa-surplus

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/manaspatil0967/tiaa-surplus
• Owner: ManasPatil0967
• Created: 2023-11-17T08:23:17.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-27T06:29:51.000Z (about 1 year ago)
• Last Synced: 2024-11-12T14:09:30.361Z (2 months ago)
• Language: Python
• Size: 172 MB
• Stars: 0
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Surplus - Retirement Income Prediction and Help Portal Dashboard

This project is a React and Flask-based application that uses Firebase for user authentication. The dashboard is designed to predict retirement income and provide help to users. The project was developed for TIAA's T3 Hack Retirement Industry Hackathon.

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Project Structure](#project-structure)

- [Firebase Integration](#firebase-integration)

- [Contributing](#contributing)

- [License](#license)

## Installation

To get started with the project, you need to have Node.js and npm installed on your machine. If you don't have them installed, you can download them from [here](https://nodejs.org/en/download/).

1. Clone the repository to your local machine.

2. Navigate to the project directory.

3. Install the necessary dependencies using the command `npm install`.

## Usage

To run the application locally:

1. Start the Flask server by navigating to the backend directory and running the command `python app.py`.

2. In a separate terminal window, navigate to the frontend directory and start the React application using the command `npm start`.

The API is deployed [https://tiaa-surplus-api.onrender.com](https://tiaa-surplus-api.onrender.com)

## Project Structure

The project is structured into two main directories: `backend` and `frontend`.

- The `python_api` directory contains the Flask application, including the API for user authentication and data prediction.

- The `dashboard` directory contains the React application, which interacts with the Flask API to display user data and predictions.