Skip to content

Greenvahn/xweather

Repository files navigation

logo

      GitHub repo size  


A simple weather app

☀️ 🌤️ ☁️ 🌧️ 🌩️

This single web app allows you to check the weather worldwide for any specific location. --> live demo.

Technologies

This project uses:

Setup

Rename .env.sample to .env and add your API key into this file. In order to get an API Key, go to OpenWeather and follow the instrunctions. Creating an account it's free! 😄

Using yarn as example but you could use npm as well. From your command line, type the following:

# Install dependencies
$ yarn install
# Run the app
$ yarn start

Other scripts available

Once the project has been installed, the following scripts to use:

lint - analize/formats source code

$ yarn lint

build - creates the deployment files ready to publish

$ yarn build

OpenWeather API

When searching places: If there are two places with the same name, the API will take the US place as default. To make it more precise put the city's name, comma, 2-letter country code (ISO3166). You will get all proper cities in chosen country. The order is important - the first is city name then comma then country. Example - London, GB or New York, US.

Geographical location via IP

This app displays the weather information based on your IP location. This data may not be accurate in some locations and can vary depending on your IP settings and geographical restrictions. For further information check Geolocation DB.

Vue CLI - configuration

See Configuration Reference.

Art direction / UI-UX

All the visual elements in use have been specifically designed for this single web app. Take a look to the intial concept and wireframes of the project on Behance.

License

You can check out the full license here.

This project is licensed under the terms of the MIT license.