diff --git a/submissions/QuantiFi_FinIq.md b/submissions/QuantiFi_FinIq.md new file mode 100644 index 0000000..28ba1a5 --- /dev/null +++ b/submissions/QuantiFi_FinIq.md @@ -0,0 +1,301 @@ +

+ + CoC Inheritance 2025 + +
+ FinIQ - Smart Investment Platform : +

+ +
+By QuantiFi Team +
+
+ +
+Table of Contents + +- [Description](#description) +- [Links](#links) +- [Tech Stack](#tech-stack) +- [Key Features](#key-features) +- [System Architecture](#system-architecture) +- [Progress](#progress) +- [Future Scope](#future-scope) +- [Applications](#applications) +- [Project Setup](#project-setup) +- [Team Members](#team-members) +- [Mentors](#mentors) + +
+ + +## Description + +**FinIQ** revolutionizes stock market analysis by combining **cutting-edge machine learning with intuitive design**. Built on the **MERN stack** with an integrated **Flask ML service**, it delivers sophisticated **LSTM-based price forecasting, real-time news sentiment analysis, and conversational AI assistance**โ€”all in one seamless platform. + +Whether you're a seasoned trader or just starting your investment journey, FinIQ transforms complex market data into **actionable insights**. + + + +## ๐Ÿ”— Links + +- [GitHub Repository](https://github.com/swamini-jadhav/FinIQ) +- [Demo Video](https://drive.google.com/drive/folders/1pE3CsY2YKWbhTr1CKZrCfcwylNtai7Sd) +- [Screenshots Folder](https://drive.google.com/drive/folders/1pE3CsY2YKWbhTr1CKZrCfcwylNtai7Sd) +- [Hosted Website](https://fin-iq-neon.vercel.app/) + + + +## ๐Ÿค– Tech-Stack + +### Frontend +* **React.js** - Component-based UI +* **TailwindCSS** - Modern styling +* **Chart.js** - Data visualization +* **React Router** - Navigation +* **Axios** - HTTP client + +### Backend +* **Node.js** - Runtime environment +* **Express.js** - Web framework +* **MongoDB** - NoSQL database +* **Mongoose** - ODM +* **JWT** - Authentication +* **Passport.js** - Auth middleware + +### ML Service +* **Flask** - Microservice framework +* **PyTorch** - Deep learning +* **LSTM Networks** - Time series forecasting +* **yfinance** - Market data +* **TextBlob** - NLP for sentiment analysis +* **NewsAPI** - News feeds + +### Hosting & Deployment +* **Vercel** - Frontend deployment +* **Render** - Backend & ML service deployment +* **MongoDB Atlas** - Cloud database + +### ๐Ÿ—๏ธ System Architecture + +```mermaid +graph TB + subgraph Client["๐Ÿ–ฅ๏ธ Client Layer"] + UI["React.js UITailwindCSS StylingChart.js Visualizations"] + end + + subgraph Frontend["๐Ÿ“ฑ Frontend - Vercel"] + App["React ApplicationPort 3000"] + end + + subgraph Backend["๐Ÿ”ง Backend - Render"] + API["Express.js API ServerPort 5000"] + Auth["JWT AuthenticationPassport.js"] + Routes["API Routes/auth, /stocks, /sentiment"] + end + + subgraph Database["๐Ÿ’พ Database - MongoDB Atlas"] + DB["MongoDBUser DataStock HistorySentiment Scores"] + end + + subgraph MLService["๐Ÿค– ML Service - Render"] + Flask["Flask MicroservicePort 5001"] + LSTM["LSTM Model60-day LookbackPrice Prediction"] + NLP["NLP EngineTextBlobSentiment Analysis"] + Chatbot["AI ChatbotInvestment Assistant"] + end + + subgraph ExternalAPIs["๐ŸŒ External APIs"] + NewsAPI["NewsAPIFinancial News"] + yfinance["yfinanceStock Data"] + end + + UI -->|HTTP Requests| App + App -->|API Calls| API + API -->|Authentication| Auth + API -->|Data Operations| Routes + Routes -->|Read/Write| DB + App -->|ML Requests| Flask + Flask -->|Training/Prediction| LSTM + Flask -->|Sentiment Score| NLP + Flask -->|Chat Response| Chatbot + LSTM -->|Fetch Data| yfinance + NLP -->|Fetch News| NewsAPI + Auth -->|Verify Tokens| Routes + + style Frontend fill:#3b82f6 + style Backend fill:#10b981 + style Database fill:#f59e0b + style MLService fill:#8b5cf6 + style ExternalAPIs fill:#ec4899 +``` +### Front-end +* [React.js](https://react.dev/) --> Component-based UI with modern hooks and state management for seamless user experience +* [TailwindCSS](https://tailwindcss.com/) --> Utility-first CSS framework for responsive, beautiful styling across all devices +* [Chart.js](https://www.chartjs.org/) --> Dynamic data visualization for stock price trends, predictions, and sentiment charts + +### Back-end +* [Node.js](https://nodejs.org/) & [Express.js](https://expressjs.com/) --> Lightweight, fast REST API server for handling client requests +* JWT Authentication --> Secure token-based authentication with Passport.js middleware for protected routes +* [Render](https://render.com/) --> Backend deployment and API hosting with automatic scaling + +### ML Service +* [Flask](https://flask.palletsprojects.com/) --> Lightweight Python microservice framework for AI/ML model serving on port 5001 +* [PyTorch](https://pytorch.org/) --> Deep learning framework for building and training neural networks +* **LSTM Networks** --> Multi-layer Long Short-Term Memory architecture with 60-day temporal lookback window for accurate price forecasting +* **yfinance** --> Real-time stock market data fetching and historical price data collection +* **TextBlob** --> Natural Language Processing for sentiment classification (Positive/Neutral/Negative) +* **NewsAPI** --> Live financial news aggregation from premium sources for sentiment analysis + +### Database +* [MongoDB](https://www.mongodb.com/) --> NoSQL document database for flexible user data, stock history, and sentiment scores +* [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) --> Cloud-hosted MongoDB with automatic backups and scaling + + + +## ๐Ÿ“ˆ Progress + +### Fully Implemented Features + +* **JWT-based Authentication System**: Secure user authentication with Passport.js and encrypted passwords +* **Real-time Stock Data Integration**: Live market data fetching using yfinance API +* **LSTM Price Prediction Model**: Deep learning model with 60-day lookback window trained on historical data +* **Sentiment Analysis Engine**: NLP-based sentiment classification using TextBlob with news API integration +* **Interactive Dashboard**: Chart.js visualizations for price trends, predictions, and sentiment data +* **AI Chatbot**: Context-aware investment assistant for stock market queries +* **Responsive UI**: Fully styled with TailwindCSS for all devices + +### Partially Implemented Features / Work in Progress + +* **Advanced Technical Indicators**: RSI, MACD, and Bollinger Bands calculations +* **Portfolio Tracking**: Multi-stock portfolio management features +* **Email/SMS Alerts**: Price alert notification system +* **Mobile App**: React Native mobile application + + + +## ๐Ÿ”ฎ Future Scope + +* **Multi-stock Portfolio Tracking**: Complete portfolio management system +* **Advanced Technical Indicators**: RSI, MACD, Bollinger Bands implementation +* **Email/SMS Price Alerts**: Notification system for price changes +* **Social Sentiment Integration**: Twitter, Reddit sentiment analysis +* **Mobile Application**: React Native iOS and Android apps +* **Enhanced ML Models**: Improved LSTM accuracy and ensemble methods +* **Real-time Collaboration**: Social features for sharing strategies +* **Backtesting Engine**: Test strategies against historical data + + + +## ๐Ÿ’ธ Applications + +1. **Stock Market Analysis Platform** - Real-time analysis combining LSTM predictions with sentiment analysis for informed trading decisions +2. **AI-Powered Investment Advisory** - Automated chatbot providing 24/7 market insights and investment guidance +3. **Sentiment-Driven Trading** - Use news sentiment as a factor in trading strategies +4. **Retail Investor Tool** - Democratizing advanced market analysis for individual traders +5. **Financial Education** - Help beginners understand stock market dynamics through visual analytics + + + +## ๐Ÿ›  Project Setup + +### Prerequisites +* Node.js (v18.x or higher) +* Python (v3.9 or higher) +* MongoDB (v6.x or higher) +* npm or yarn +* pip (Python package manager) + +### 1๏ธโƒฃ Clone the Repository +```bash +git clone https://github.com/QuantiFi/FinIQ.git +cd FinIQ +``` + +### 2๏ธโƒฃ Backend Setup +```bash +cd backend + +# Install dependencies +npm install + +# Create .env file +cat > .env << EOF +PORT=5000 +MONGODB_URI=mongodb://localhost:27017/finiq +JWT_SECRET=your_jwt_secret_key_here +NODE_ENV=development +EOF + +# Start the server +npm start +``` +Backend runs on **http://localhost:5000** + +### 3๏ธโƒฃ ML Service Setup +```bash +cd ../ml-service + +# Create virtual environment +python -m venv venv + +# Activate virtual environment +# On Windows (Command Prompt): +venv\Scripts\activate +# On Windows (PowerShell): +venv\Scripts\Activate.ps1 +# On macOS/Linux: +source venv/bin/activate + +# Install dependencies +pip install -r requirements.txt + +# Create .env file +cat > .env << EOF +FLASK_PORT=5001 +NEWS_API_KEY=your_newsapi_key_here +FLASK_ENV=development +EOF + +# Start Flask service +python app.py +``` +ML Service runs on **http://localhost:5001** + +### 4๏ธโƒฃ Frontend Setup +```bash +cd ../frontend + +# Install dependencies +npm install + +# Create .env file +cat > .env << EOF +REACT_APP_API_URL=http://localhost:5000 +REACT_APP_ML_API_URL=http://localhost:5001 +EOF + +# Start development server +npm start +``` +Frontend runs on **http://localhost:3000** + +### ๐Ÿ”‘ API Keys Required +* **NewsAPI**: Get your free key at [newsapi.org](https://newsapi.org) +* **MongoDB**: Set up local instance or use MongoDB Atlas + + + +## ๐Ÿ‘จโ€๐Ÿ’ป Team Members + +* **Sahil Apage**: [GitHub](https://github.com/sahilapage) +* **Swamini Jadhav**: [GitHub](https://github.com/swamini-jadhav) +* **Muskaan Karwa**: [GitHub](https://github.com/muskaankarwa) +* **Aaradhana Chaudhary**: [GitHub](https://github.com/aaradhanac07) + + + +## ๐Ÿ‘จโ€๐Ÿซ Mentors + +* **Rushabh Mehta**: [LinkedIn](https://github.com/RushabhMehta2005) +* **Siddhesh Pandey**: [GitHub](https://github.com/sid-7905) \ No newline at end of file