Skip to content

Repository files navigation

Stock Screener App

A stock screening tool built with Vite, TypeScript, and React that allows users to filter and analyze stocks based on various financial metrics, such as market capitalization, P/E ratio, ROE, and more.

Features

  • Interactive Query Input: Users can input custom queries to filter stocks based on specific criteria.
  • Example Queries: Provides sample queries to help users get started with filtering stocks.
  • Responsive Design: Adapts to different screen sizes for an optimal viewing experience on both desktop and mobile.
  • Built with Modern Stack: Utilizes Vite for fast builds, TypeScript for type safety, and React for component-based architecture.

Technologies Used

  • Vite: For fast and optimized development.
  • TypeScript: For static typing and easier maintainability.
  • React: For creating a component-driven UI.
  • Tailwind CSS: For rapid and efficient styling.
  • PostCSS: For extended styling capabilities.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/stock-screener-app.git
    
  2. Navigate into project directory:

    cd stock-screener-app
    
  3. Install dependencies:

    npm install
    
  4. Run the development server:

    npm run dev
    

Usage

  • Enter your query in the input box to screen stocks based on criteria such as market capitalization, P/E ratio, and ROE.
  • Click "Run Query" to see the filtered results.
  • Refer to Example Queries for guidance on how to structure your inputs.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages