/weather-app

Check it out the current and the next 24 hours weather of 5 European cities!

Primary LanguageTypeScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

How's the weather?

Check it out the current and the next 24 hours weather of 5 European cities!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Product Name Screen Shot

Check it out the current and the next 24 hours weather of 5 European cities!

Features:

  • Gets all data from a public API: https://openweathermap.org
  • Shows the weather of Amsterdam, Bristol, Brussels, London and Krakow
  • Shows the current weather of each city, with the information about: city's name, main weather, weather description, average temperature, wind speed and the current hour
  • Shows the next 24 hours at a click

Built With

Getting Started

Prerequisites

  • npm

    npm install npm@latest -g
  • yarn

    npm install --global yarn

Installation

  1. Get a free API Key at Open Weather Map
  2. Clone the repo
    git clone https://github.com/jennifertakagi/weather-app.git
  3. Install packages
    yarn | npm install
  4. Enter your API in .env.js
    API_KEY= = 'ENTER YOUR API'
  5. Run the following command in root folder to start (on port 4200) the application in a development environment
    yarn start | npm run start
  6. Run tests on project
    yarn test | test:coverage

Usage

  • Mobile version

Roadmap

See the open issues for a list of proposed features (and known issues).

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
  6. Check the test coverage, it has 82,8% of unit tests coverage.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jennifer Takagi - @jennitakagi

Check out the demo project