Skip to content

SimonMilord/stonkers.ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

202 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“ˆ Stonkers.ai

Your intelligent stock analysis platform

A modern, responsive web application built with React and TypeScript that provides comprehensive stock market analysis, portfolio management, and financial insights powered by real-time market data.

React TypeScript Vite Mantine

Try it out here!

Link to the backend repo

โœจ Features

๐Ÿ  Market Overview

  • Stock quotes and market data
  • Company profiles and financial metrics
  • Market news and analysis
  • AI generated analysis of risks and competitive advantages

๐Ÿ’ผ Portfolio Management

  • Track stock holdings and cash positions
  • Portfolio valuation
  • Drag-and-drop portfolio reordering
  • Performance tracking
  • Interactive pie chart visualization

๐Ÿ‘๏ธ Watchlist

  • Monitor favorite stocks
  • Customizable watchlist ordering
  • Quick access to stock details

๐Ÿงฎ Investment Calculator

  • Calculate potential returns and target prices
  • Scenario analysis tools
  • Supports 2 methods: EPS and FCF

๐Ÿ” Advanced Search

  • Intelligent stock symbol search
  • Company lookup and discovery

๐Ÿ” Authentication

  • Google OAuth integration
  • Guest access mode
  • Secure session management
  • Protected routes

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Backend API server (configured separately)

Installation

  1. Clone the repository

    git clone https://github.com/SimonMilord/stonkers.ai.git
    cd stonkers.ai
  2. Install dependencies

    npm install
  3. Environment Setup Create a .env file in the root directory:

    VITE_BACKEND_URL=your_backend_api_url
  4. Start the development server

    npm start
  5. Open your browser Navigate to http://localhost:3000

๐Ÿ—๏ธ Tech Stack

Frontend Framework

  • React 19 - Modern UI library with hooks and context
  • TypeScript - Type-safe JavaScript development
  • Vite - Fast build tool and development server

UI & Styling

  • Mantine 7.16 - Modern React components library
  • Chart.js - Interactive charts and data visualization
  • React Icons - Comprehensive icon library
  • CSS Custom Properties - Theming and responsive design

State Management

  • React Context - Authentication and stock data management
  • Custom Hooks - Reusable business logic
  • Local State - Component-level state management

Routing & Navigation

  • React Router 5 - Client-side routing
  • Protected Routes - Authentication-based access control

Development Tools

  • ESLint - Code quality and consistency
  • Prettier - Code formatting
  • PostCSS - CSS processing and optimization

๐Ÿ“ Project Structure

src/
โ”œโ”€โ”€ components/           # Reusable UI components
โ”‚   โ”œโ”€โ”€ addHoldingForm/   # Portfolio stock/cash addition
โ”‚   โ”œโ”€โ”€ calculatorFormCard/  # Investment calculator
โ”‚   โ”œโ”€โ”€ companyProfileCard/  # Company information display
โ”‚   โ”œโ”€โ”€ portfolioTable/   # Portfolio holdings table
โ”‚   โ”œโ”€โ”€ searchBox/        # Stock symbol search
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ contexts/            # React Context providers
โ”‚   โ”œโ”€โ”€ authContext.tsx  # Authentication state
โ”‚   โ””โ”€โ”€ stockContext.tsx # Stock data management
โ”œโ”€โ”€ hooks/               # Custom React hooks
โ”‚   โ”œโ”€โ”€ usePortfolioHoldings.ts  # Portfolio state management
โ”‚   โ”œโ”€โ”€ useStockData.ts  # Market data fetching
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ pages/               # Main application pages
โ”‚   โ”œโ”€โ”€ homePage.tsx     # Market overview
โ”‚   โ”œโ”€โ”€ portfolioPage.tsx # Portfolio management
โ”‚   โ”œโ”€โ”€ watchlistPage.tsx # Stock watchlist
โ”‚   โ”œโ”€โ”€ calculatorPage.tsx # Investment calculator
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ types/               # TypeScript type definitions
โ”œโ”€โ”€ utils/               # Utility functions and API calls
โ””โ”€โ”€ styles/              # Global styles and themes

๐ŸŽจ Key Components

Portfolio Management

  • Real-time tracking of stock holdings and cash positions
  • Drag-and-drop reordering with persistent backend sync
  • Performance metrics including total value, gains/losses
  • Interactive visualizations with pie charts

Market Data Integration

  • Finnhub API integration for real-time market data
  • Bulk quote fetching for optimal performance
  • Error handling and fallbacks for reliable data access
  • Caching strategies for improved user experience

User Experience

  • Responsive design for mobile and desktop
  • Loading states and error handling for smooth interactions
  • Toast notifications for user feedback
  • Dark theme support with CSS custom properties

๐Ÿ”ฎ What's Coming in V2.0

The next major release will bring powerful new features and enhancements:

๐Ÿ”„ Real-time Updates

  • WebSocket integration for automatic quote refresh
  • Real-time portfolio value updates

๐Ÿ” Enhanced Search & Discovery

  • Query suggestions for improved stock discovery
  • Enhanced company lookup capabilities

๐Ÿ“Š Advanced Analytics & Reporting

  • Earnings summary page with comprehensive analysis
  • Insider transactions tracking for better investment insights
  • AI-powered comprehensive stock reports with deep analysis
  • Enhanced earnings surprise analysis

๐Ÿ“ˆ Improved Portfolio Features

  • Multi-currency support for international portfolios
  • Transaction history tracking for detailed performance analysis
  • Advanced performance metrics and benchmarking
  • Enhanced portfolio analytics dashboard

๐Ÿ’น Enhanced Charting & Visualization

  • Additional chart types and timeframes
  • Advanced portfolio visualization tools
  • Performance comparison charts

๐Ÿงฎ Advanced Calculator

  • Extended investment parameters for more accurate projections
  • Additional valuation methods and models
  • Scenario analysis with multiple variables

๐Ÿ‘๏ธ Watchlist Improvements

  • Multiple watchlist support for better organization
  • Notes and annotations for each stock
  • Custom alerts and notifications

Stay tuned for these exciting updates coming in 2026!

๐Ÿš€ Deployment

Vercel Deployment

The project is configured for Vercel deployment with:

  • Automatic builds from develop branch
  • SPA routing configuration
  • Environment variable support

๐Ÿ”Œ API Integration

The application integrates with a backend API for:

  • Authentication - Google OAuth and guest access
  • Portfolio data - CRUD operations for holdings
  • Watchlist management - Stock tracking and organization
  • Market data - Real-time quotes and company information
  • AI inference - Groq inference API to generate content

๐ŸŽฏ Performance Optimizations

  • Code splitting with React lazy loading
  • Memoized calculations for expensive operations
  • Bulk API requests to minimize network calls
  • Progressive loading for improved perceived performance

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ™ Acknowledgments

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages