README.md

Alpha Stonks - stocks/etfs broking website

Shop for your favourite Stocks/etfs

Introduction · How It Works · Tech Stack · Screenshots · Running Locally · Author

Introduction

AlphaStonks is an online platform for stock market data. It shows top-performing and underperforming stocks, offers stock details and financials, and provides Line, Candlestick, and Bar charts. It includes a quick search feature for your favorite stocks.

Features

• Top 20 gainers and losers displayed on the Home page.
• Company Details Page.
• Visualization of the Stock performance using Charts.
• Financials of the stock displayed on the company page.
• Search functionality to search for the stocks.
• Filter feature to filter the search among Stock, ETF, Mutual Fund.
• Suggested Stocks in the search bar.

Tech Stack

• Javascript
• NextJS
• Alphavantage API
• Tailwind CSS
• Shadcn ui
• Zustand
• React Google Charts (For data visualization)

Screenshots

Home Page

Company Details Page

Line Chart

Area Chart

Search Functionality

Running Locally

Cloning the repository to the local machine.

git clone

Creating an account on Alphavantage to get an API key.

1. Get an API key from the API Keys section.

Storing API key in .env file.

Create a file in root directory of project named .env.local. And store your API key in it.

Installing the dependencies.

npm install

Running the application.

Then, run the application in the command line and it will be available at http://localhost:3000.

npm run dev

Author

• Anchit Sinha (@anchit1909)