Skip to content

README.md

Latest commit

 

History

History
156 lines (109 loc) · 3.4 KB

README.md

File metadata and controls

156 lines (109 loc) · 3.4 KB

💹 FinTrack

FinTrack is a full-stack stock trading and portfolio management dashboard. It lets users sign up, log in, view real-time stock prices, place trades, and track their portfolios. The app is built using the MERN stack (MongoDB, Express, React, Node.js) and integrates with the Alphavantage API for market data. Some important features are:

  1. Buy/Sell Engine
  2. AI-Chatbot using OpenAI's API key
  3. Stock Price Prediction using self built ML model.

Deployed Model test link: https://stock-analyser-ggjy.onrender.com/predict/MSFT Replace MSFT with any Stock ticket you like.

🚀 Tech Stack

Layer Technology
Frontend React (Vite), Tailwind CSS, Bootstrap
Backend Node.js, Express
Database MongoDB + Mongoose
Auth JWT + HTTP-only cookies + bcrypt
API AlphaVantage API

📁 Project Structure


fin\_track/
├── backend/         # Express API server
│   ├── controllers/
│   ├── middleware/
│   ├── routes/
│   ├── models/
│   └── index.js
├── frontend/        # Public-facing React app (signup/login)
│   └── ...
├── dashboard/       # Private user dashboard (portfolio etc.)
│   └── ...
├── screenshots/     # UI screenshots
└── README.md

🔐 Environment Variables

✅ backend/.env.sample

PORT=3002
MONGODB_URI=mongodb+srv://<username>:<password>@cluster.mongodb.net/fintrack-db
JWT_SECRET=your_jwt_secret
CLIENT_URL=http://localhost:5173

✅ frontend/.env.sample

REACT_APP_BACKEND_URL=http://localhost:3002
REACT_APP_API_KEY=your_alphavantage_api_key

✅ dashboard/.env.sample

REACT_APP_BACKEND_URL=http://localhost:3002
REACT_APP_DASHBOARD_URL=http://localhost:5174
REACT_APP_API_KEY=your_alphavantage_api_key

🔁 Rename .env.sample to .env and update all placeholder values before running.

🛠️ Setup Guide

1️⃣ Clone the Repo

git clone https://github.com/<your-username>/fin_track.git
cd fin_track

2️⃣ Backend Setup

cd backend
npm install
cp .env.sample .env    # and update it
npm run dev

Server runs at http://localhost:3002

3️⃣ Frontend Setup

cd ../frontend
npm install
cp .env.sample .env
npm run dev

Runs on http://localhost:5173

4️⃣ Dashboard Setup

cd ../dashboard
npm install
cp .env.sample .env
npm run dev

Dashboard available at http://localhost:5174

🌐 API Endpoints

Route Method Description
/signup POST Register new user
/login POST Login and set secure cookie
/logout POST Log out user
/verify GET Check if user is authenticated
/holdings GET Get user's current stock holdings
/positions GET Fetch all trade positions
/orders POST Place a buy/sell order

🙌 Acknowledgements

  • 💰 Market data from ALPHA_VANTAGE
  • 🎨 UI powered by Bootstrap + TailwindCSS

👤 Maintainer

Vaibhav Tyagi