An open API service indexing awesome lists of open source software.

https://github.com/markmybytes/wmo-wx-widget

A responsive, self-hostable weather widget that provide official weather information around the world.
https://github.com/markmybytes/wmo-wx-widget

Last synced: 4 months ago
JSON representation

A responsive, self-hostable weather widget that provide official weather information around the world.

Awesome Lists containing this project

README

          

[![Tag][tag-shield]][tag-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License][license-shield]][license-url]





logo

wmo-wx-widget


A responsive, self-hostable weather widget that provide official weather information around the world.


Report Bug
·
Request Feature


## About The Project


project screenshot

An alternative to the weather widgets that already exists on the internet.

_wmo-wx-widget_ brings you the weather information form a trustworthy source [World Meteorological Organization](http://wmo.int/about-wmo/overview), which relay the data from the local weather forecast organisation around the world.

(back to top)

### Built With

[](https://tailwindcss.com/)
[](https://nextjs.org/)
[](https://tailwindcss.com/)

(back to top)

## Getting Started

### Prerequisites

- Node 22 https://nodejs.org/en/download/package-manager

### Setup

#### Install dependencies

- Install NPM packages
```sh
npm install
```

#### Commands

* Development
```sh
npm run dev
```
* Preview
```sh
npm run build && npm run start
```
* Docker Build
```sh
docker build -t wmo-wx-widget .
```

(back to top)

## Usage

### Responsive Widget

The widget will adjust itself to accomandate the size of the screen.

responsive demo

### Widget Customiser

A configurating tool to configure the location and various display settings.

widget customiser screenshot

### Embedding

The widget can be embedding to note taking apps like Notion for your travel plans or working plans.

notion embedding screenshot

(back to top)

[tag-url]: https://github.com/markmybytes/wmo-wx-widget/releases
[tag-shield]: https://img.shields.io/github/v/tag/markmybytes/wmo-wx-widget?style=for-the-badge&label=LATEST&color=%23B1B1B1
[contributors-shield]: https://img.shields.io/github/contributors/markmybytes/wmo-wx-widget.svg?style=for-the-badge
[contributors-url]: https://github.com/markmybytes/wmo-wx-widget/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/markmybytes/wmo-wx-widget.svg?style=for-the-badge
[forks-url]: https://github.com/markmybytes/wmo-wx-widget/network/members
[stars-shield]: https://img.shields.io/github/stars/markmybytes/wmo-wx-widget.svg?style=for-the-badge
[stars-url]: https://github.com/markmybytes/wmo-wx-widget/stargazers
[issues-shield]: https://img.shields.io/github/issues/markmybytes/wmo-wx-widget.svg?style=for-the-badge
[issues-url]: https://github.com/markmybytes/wmo-wx-widget/issues
[license-shield]: https://img.shields.io/github/license/markmybytes/wmo-wx-widget?style=for-the-badge
[license-url]: https://github.com/markmybytes/wmo-wx-widget/blob/master/LICENSE
[product-screenshot]: https://github.com/markmybytes/wmo-wx-widget/assets/71750702/e605d36b-e0a0-46ba-adec-f65fa260679b