https://github.com/tommyxchow/stawks

A web app that renders charts, details, and news for stocks.
https://github.com/tommyxchow/stawks

chartjs finance nextjs react reactjs stocks tailwind tailwindcss typescript vercel

Last synced: 14 days ago
JSON representation

A web app that renders charts, details, and news for stocks.

• Host: GitHub
• URL: https://github.com/tommyxchow/stawks
• Owner: tommyxchow
• License: mit
• Created: 2022-10-03T23:34:59.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-13T01:41:21.000Z (12 months ago)
• Last Synced: 2024-10-04T19:08:39.259Z (about 1 month ago)
• Topics: chartjs, finance, nextjs, react, reactjs, stocks, tailwind, tailwindcss, typescript, vercel
• Language: TypeScript
• Homepage: https://stawks.vercel.app
• Size: 893 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [STAWKS](https://stawks.vercel.app/)

![Screenshot](https://user-images.githubusercontent.com/54859075/195729432-ffddb917-e06b-47bd-af28-d9d07beaaa04.png)

A web app that renders price history charts, details, and news for stocks. Only supports entering stock tickers due to limitations with the IEX Cloud API.

## Background

When I took my first intro to CS course back in 2019, the final project I worked on was a really basic stock web app ([here](https://github.com/tommyxchow/stock-chart-visualizer)). I've learned a lot since, so I decided to make a remake/remaster of it! I rebuilt the project using the same API but with a more modern stack and overall nicer design.

## Stack

- [Next.js](https://nextjs.org/)

- [Tailwind CSS](https://tailwindcss.com/)

- [Chart.js](https://www.chartjs.org/)

- [SWR](https://swr.vercel.app/)

- [Vercel](https://vercel.com/)

## Setup

You'll first have to register for an account on [IEX Cloud](https://iexcloud.io/) to obtain an API token. Then, set the token as the `IEX_TOKEN` [environment variable](https://nextjs.org/docs/basic-features/environment-variables).

You can refer to the [IEX Cloud API documentation](https://iexcloud.io/docs/api/) for more details.

## Notes

The IEX Cloud API is now pretty limited on the free tier, so the website displays fallback data to maintain interactivity.

STAWKS utilizes [incremental static regeneration (ISR)](https://nextjs.org/docs/basic-features/data-fetching/incremental-static-regeneration) from Next.js to statically generate stock pages while also keeping data up to date, resulting in excellent performance. The homepage is revalidated every 30 minutes while the stock page is revalidated every minute.

## License

STAWKS is licensed under [MIT](LICENSE).