Ur-Weather App

Simple and minimilistic weather app that displays relevant weather information!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

About The Project

This project was designed for two main purposes. One being the chance to learn the Vaadin framework and the other being the chance to learn more about REST APIs and how they are used in different applications.

These two major concepts were used to develop a web application that displays relevant weather information for the user. Hourly and Daily weather information is also displayed at the bottom of the website. For extra detail about the weather, you can also open the Details tab.

Built With

• Vaadin
• Spring Boot
• Maven
• ClimaCell API
• GeoDB API

Getting Started

The following are steps for users who wish to get a local copy of the web application running on their machine.

Prerequisites

The following needs to be installed on your machine for the application to properly work.

• Maven
  • Download Tutorial

Installation

1. Go to prefered directory

cd FakeFolder/NotRealDirectory/

2. Clone the repo

git clone https://github.com/Mathew-Estafanous/Ur-Weather-App.git

3. Run app using maven

mvn spring-boot:run

Usage

The program is very simple and easy to use. Once you open the website page, go to the top navigation bar and input the city you would like to get weather information for.

The format required is as follows: City Name, Country Code (ie. Vancouver, CA)

Once you input and click the search button, you can now look through all the displayed information and tab through the detail, hourly and daily weather figures.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is Unlicensed and is free to be used! See LICENSE for more information.

Contact

Mathew Estafanous - mathewestafanous13@gmail.com

Project Link: https://github.com/Mathew-Estafanous/Ur-Weather-App