https://github.com/zafar-saleem/stock-data
https://github.com/zafar-saleem/stock-data
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zafar-saleem/stock-data
- Owner: zafar-saleem
- Created: 2024-03-28T05:17:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-28T12:34:00.000Z (over 1 year ago)
- Last Synced: 2025-01-01T03:27:34.729Z (10 months ago)
- Language: TypeScript
- Homepage: https://stock-data-silk.vercel.app
- Size: 456 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
## About The Project
This project retrieves stock data from third party API endpoint and render them in a table.
### Built With
Below are the core technologies I used for this project.
* [Next.js](https://nextjs.org/)
* [React](https://reactjs.org/)
* [Typescript](https://www.typescriptlang.org/)
* [tailwind](https://tailwindcss.com/)
* [Vercel](https://vercel.com/)
* [Github](https://github.com/)
* [eslint](https://eslint.org/)
* [prettier](https://prettier.io/)
* [husky](https://github.com/typicode/husky)
## Getting Started
To run this project, please follow the steps below.
### Prerequisites
To install node 20.7.0, run the command below.
* node
```sh
nvm install v20.7.0
```
To install yarn run the command below.
* yarn
```sh
npm install --global yarn
```
### Installation
1. Clone the repo
```sh
git@github.com:zafar-saleem/stock-data.git
```
2. Install NPM packages
```sh
yarn
```
## Usage
To run the project, below command will help.
```sh
yarn dev
```
## Folder Structure
```bash
.
├── README.md
├── app
│ ├── favicon.ico
│ ├── globals.css
│ ├── layout.tsx
│ └── page.tsx
├── commitlint.config.js
├── hooks
│ └── useAllDailyStocks.ts
├── next-env.d.ts
├── next.config.mjs
├── package-lock.json
├── package.json
├── postcss.config.js
├── providers
│ └── react-query-provider.tsx
├── public
│ ├── next.svg
│ └── vercel.svg
├── screenshots
│ ├── git-strategy.png
│ └── screenshot.png
├── services
│ └── daily-service.ts
├── tailwind.config.ts
├── tsconfig.json
└── yarn.lock
```
## Git Strategy
Below is the complete git workflow.
## Dev Links
* [GitHub Project](https://github.com/zafar-saleem/stock-data)
* [Commits](https://github.com/zafar-saleem/stock-data/commits/main/)
* [CI/CD Pipelines](https://github.com/zafar-saleem/stock-data/deployments)
* [Branches](https://github.com/zafar-saleem/stock-data/branches)
* [Live Demo](https://stock-data-silk.vercel.app/)