README.md

wmo-wx-widget

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

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

This project is an alternative to the weather widgets that already exists on the internet.

The purpose of this project is to provide weather information form a trustworthy source -- World Meteorological Organization, which relay the data from the local weather organisation around the world.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Setup

1. Clone the repo

   git clone https://github.com/SuperDumbTM/wmo-wx-widget.git

2. Install NPM packages

   npm install

Deploy

• Development

  npm run dev

• Production

  npm run build && npm run start

• Docker Build

  docker build -t wmo-wx-widget .

(back to top)

Usage

Responsive Widget

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

Widget Customiser

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

Notion Embedding

Embedding the widget in note taking app should work like a charm.

(back to top)