https://github.com/kanphatdev/ts-weather-app

https://github.com/kanphatdev/ts-weather-app

Last synced: about 16 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/kanphatdev/ts-weather-app
• Owner: kanphatdev
• Created: 2024-09-16T09:32:02.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T07:19:50.000Z (about 2 months ago)
• Last Synced: 2024-09-18T19:24:25.826Z (about 2 months ago)
• Language: TypeScript
• Size: 195 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Here's an updated version of your README with the tutorial reference link added below the API Reference section:

---

# Project README

## Tech Stack

This project uses the following technologies and tools:

| Technology        | Description                                                                 |

|-------------------|-----------------------------------------------------------------------------|

| **Next.js**       | A React framework for building server-side rendered and static web applications. |

| **TypeScript**    | A statically typed superset of JavaScript that provides type safety and improves code quality. |

| **JavaScript**    | A high-level, dynamic programming language used for web development. |

| **Tailwind CSS**  | A utility-first CSS framework for creating custom designs without leaving your HTML. |

| **Shadcn**        | A design system providing pre-built components for React applications. |

| **Lucide Icons**  | A collection of open-source icons for use in web applications. |

| **React**         | A JavaScript library for building user interfaces with component-based architecture. |

| **Axios**         | A promise-based HTTP client for making API requests in JavaScript. |

| **React Leaflet** | A library for integrating interactive maps into React applications using Leaflet.js. |

| **Next Themes**   | A utility to add dark/light mode functionality to Next.js applications. |

## Environment Variable

The project requires the following environment variable to be set:

- `OPENWEATHER_API_KEY=`

Make sure to set this variable in a `.env.local` file at the root of your project.

## API Reference

The project integrates with the following external APIs for weather data:

| API Name          | Base URL                                             | Description                                                                 |

|-------------------|------------------------------------------------------|-----------------------------------------------------------------------------|

| **OpenWeather**   | [https://api.openweathermap.org/](https://api.openweathermap.org/) | Provides weather data for various locations around the globe. Requires an API key for access. |

| **Open-Meteo**    | [https://api.open-meteo.com/](https://api.open-meteo.com/)         | A free weather API that provides forecast data without requiring an API key. |

## Tutorial and Reference Video

For more information on the project setup and tutorial, check the following video:

[Reference Project](https://www.youtube.com/watch?v=rscl9VwwnQg&t=19690s)

---

This README includes the YouTube link under the "Tutorial and Reference Video" section, as you requested.