Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sanidhyy/pwa-weather-app

A Progressive Weather Application using React JS
https://github.com/sanidhyy/pwa-weather-app

pwa react reactjs redux styled-components weather-app web-application

Last synced: 3 days ago
JSON representation

A Progressive Weather Application using React JS

Awesome Lists containing this project

README

        

# A Progressive Weather Application using React JS

![PWA Weather App using React JS](https://user-images.githubusercontent.com/71302066/177005735-619edae8-6740-45fa-bb70-19b8a74e7d5a.png "PWA Weather App using React JS")

[![Ask Me Anything!](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://github.com/Technical-Shubham-tech "Ask Me Anything!")
[![GitHub license](https://img.shields.io/github/license/Technical-Shubham-tech/pwa-weather-app)](https://github.com/Technical-Shubham-tech/pwa-weather-app/blob/main/LICENSE.md "GitHub license")
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/Technical-Shubham-tech/pwa-weather-app/commits/main "Maintenance")
[![GitHub branches](https://badgen.net/github/branches/Technical-Shubham-tech/pwa-weather-app)](https://github.com/Technical-Shubham-tech/pwa-weather-app/branches "GitHub branches")
[![Github commits](https://badgen.net/github/commits/Technical-Shubham-tech/pwa-weather-app/main)](https://github.com/Technical-Shubham-tech/pwa-weather-app/commits "Github commits")
[![Netlify Status](https://api.netlify.com/api/v1/badges/c3d78e12-4a59-4a95-a90f-7a2b673cffc4/deploy-status)](https://react-app-pwa-weather.netlify.app/ "Netlify Status")
[![GitHub issues](https://img.shields.io/github/issues/Technical-Shubham-tech/pwa-weather-app)](https://github.com/Technical-Shubham-tech/pwa-weather-app/issues "GitHub issues")

## :warning: Before you start

1. Make sure [Git](https://git-scm.com "Git") and [NodeJS](https://nodejs.org "NodeJS") are installed
2. **Yarn** is faster than Npm. So use [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/ "Yarn").
3. Create `.env` file in root folder.
4. Contents of `.env`

```
REACT_APP_OPENWEATHER_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXX
```

5. Create an [Open Weather Map](https://openweathermap.org/ "Open Weather Map") account.
6. Copy your API Key as shown below and paste it in `.env` file.

![Copy API Key](https://user-images.githubusercontent.com/71302066/177005905-b2dba122-0b24-4c08-b331-cabd6c55d3fa.png "Copy API Key")
7. You are ready to go :fire:

_NOTE:_ Never share these Keys publicaly.

## :pushpin: How to use this App?

1. Clone this **repository** to your local computer.
2. Open **terminal** in root directory.
3. Type and Run `npm install` or `yarn install`.
4. Once packages are installed, you can start this app using `npm start` or `yarn start`
5. Now app is fully configured and you can start using this app :+1:

## :fire: Features

- Supports all **PWA Apps** Functionality.
- **Offline** Mode.
- **Easy to customize** file structure.
- Can be installed like **native** web app.
- Passes all **Lighthouse** checks.
- **Mobile** Responsive Layout

## :camera: Screenshots:

![Mobile Responsive](https://user-images.githubusercontent.com/71302066/177006299-5e0b9d80-75d6-44c7-be11-f00016bbbe47.png "Mobile Responsive")

![PWA Support](https://user-images.githubusercontent.com/71302066/177006363-6ed1330d-fd7f-4c28-947b-538a001f8e0a.png "PWA Support")

![Lighthouse pwa check passed](https://user-images.githubusercontent.com/71302066/177006407-72df3769-443d-4956-a4b5-16c3d60158ae.png "Lighthouse pwa check passed")

## :gear: Built with

[](https://www.javascript.com/ "JavaScript")

[](https://reactjs.org/ "React JS")

[](https://en.wikipedia.org/wiki/Progressive_web_application "Progressive Web Apps")

[Built with Love](https://github.com/Technical-Shubham-tech "Built with Love")

## :wrench: Stats

![Stats for this App](https://user-images.githubusercontent.com/71302066/177006450-9311051e-3bee-4fec-ba07-62d00f1a5f67.svg "Stats for this App")

[PWA Lighthouse Report](https://googlechrome.github.io/lighthouse/viewer/?gist=de3fa97d313f8d75e0878ec5f84ff279 "PWA Lighthouse Report")

## :raised_hands: Contribute

You might encounter some bugs while using this app. You are more than welcome to contribute. Just submit changes via pull request and I will review them before merging. Make sure you follow community guidelines.

## Buy Me a Coffee 🍺

[](https://www.buymeacoffee.com/sanidhy "Buy me a Coffee")

## :rocket: Follow Me

[![GitHub followers](https://img.shields.io/github/followers/Technical-Shubham-tech?style=social&label=Follow&maxAge=2592000)](https://github.com/Technical-Shubham-tech "Follow Me")
[![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2FTechnicalShubam)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FTechnical-Shubham-tech%2Fmedical-chat-app "Tweet")
[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/channel/UCNAz_hUVBG2ZUN8TVm0bmYw "Subscribe my Channel")

## :star: Give A Star

You can also give this repository a star to show more people and they can use this repository.

## :books: Available Scripts

In the project directory, you can run:

### `yarn start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `yarn test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn 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](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `yarn eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## :page_with_curl: Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `yarn build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)