Skip to content

Latest commit

 

History

History
executable file
·
87 lines (52 loc) · 3.85 KB

README.md

File metadata and controls

executable file
·
87 lines (52 loc) · 3.85 KB
Raw

README

React Weather App

Motivation

I built this application because I wanted to learn more about using React. Specifically, I wanted to learn about using APIs with React.

How to use

You can use this application by visiting the app and entering a city and country into the form fields. The application will then return the forecast for that location.

Live preview

See this application in action at https://agitated-franklin-55a50d.netlify.com/.

Tech/framework used

This application was built with React and bootstrapped using Create React App. You can learn more about Create React App here: https://github.com/facebook/create-react-app. It also utilizes the OpenWeather API and NPM.

This application is also being hosted with Netlify. Learn more about Netlify at https://www.netlify.com/.

OpenWeather API

This application utilizes the OpenWeather API. This API is a beginner-friendly tool that can be used to return weather forecasts. You can find the OpenWeather guide here: https://openweathermap.org/guide. The documentation for OpenWeather can be found here: https://openweathermap.org/api.

You can use OpenWeather to pull a variety of weather information including: -Current weather data -5 day/3 hour forecast -16 day/daily forecast

See documentation for more info!

Requirements

You must have the following installed to run this application: -Node.js/NPM (see: https://www.npmjs.com/get-npm) -React (https://codeburst.io/installing-reactjs-and-creating-your-first-application-d437706498ed)

Installation

You can set up and run this app by doing the following:

  1. Clone Git repository to desktop or desired directory
  2. Navigate to directory in the terminal
  3. Run npm install in the terminal *This will install of the required dependencies and packages that are needed for the application to work.
  4. Run npm start to start the project locally
  5. Navigate to http://localhost:3000/ in Google Chrome or a browser of your choice.

Tests

N/A

Build commands

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

License

Copyright <2019>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.