Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/masumajaffery/weather-app
The Weather App is based on Iraq Weather Forecast. Fetching Data from open source weather Api and renders on web app.
https://github.com/masumajaffery/weather-app
bootstrap css3 html5 javascript react react-hooks reactjs reactrouter redux
Last synced: about 2 months ago
JSON representation
The Weather App is based on Iraq Weather Forecast. Fetching Data from open source weather Api and renders on web app.
- Host: GitHub
- URL: https://github.com/masumajaffery/weather-app
- Owner: MasumaJaffery
- Created: 2023-08-13T12:46:24.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-08-15T17:53:56.000Z (4 months ago)
- Last Synced: 2024-08-16T19:13:50.556Z (4 months ago)
- Topics: bootstrap, css3, html5, javascript, react, react-hooks, reactjs, reactrouter, redux
- Language: JavaScript
- Homepage: https://masumajaffery.github.io/weather-app/
- Size: 3.69 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Iraq Weather Forecast
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**[Iraq Weather Forecast]**
HTML+CSS+BOOTSTRAP+REACT+REDUX+GITHUB
Technologies
- **[User-Interactive]**
- **[Adaptability]**
- **[Performance]**
- [Live Project Link](https://masumajaffery.github.io/weather-app/)
- [Video Link](https://drive.google.com/file/d/1HX2jWjKnmAOlyV0AQKdSs0knlaVsdL1E/view?usp=sharing)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need the following tools:
- Node installed in your computer
- IDE(e.g.: Vscode,...)
- HTML-CSS-BOOTSTRAP-REACT-REDUX-GitHub
- etc.
### Setup
Clone this repository to your desired folder:
### Install
- Install project's packages with:
```sh
cd weather-app
npm install or npm i
```
# Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Run this command in Terminal;
$ npx create-react-app .
## Install Dependencies
Run this command in Terminal;
After cloning the repository you can run `npm install` to get dependencies.
$ npm install redux react-redux redux-logger
$ npm install react-router-dom
for testing;
$ npm install --save-dev jest @babel/preset-env @babel/preset-react react-test-renderer
### Available Scripts
In the project directory, you can run:
### `npm 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.
### `npm 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.
### `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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run 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.
## 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)
### `npm run 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)
### Usage
To run the project, execute the following command:
Open index.html using live server extention.
## Run Tests
To run tests, run the following command:
Track CSS linter errors run:
npx stylelint "**/*.{css,scss}"
Track JavaScript linter errors run:
npx eslint "**/*.{js,jsx}"
## Deployment
You can deploy this project using: GitHub and Netify,
- I used GitHub Pages to deploy my website.
- For more information about publishing sources, see "About GitHub pages".
👤 **Syeda Masuma Fatima**
- GitHub: [@MasumaJaffery](https://github.com/MasumaJaffery)
- Twitter: [@MasumaJaffery](https://twitter.com/MasumaJaffery)
- LinkedIn: [Masuma Jaffery](https://www.linkedin.com/in/masuma-jaffery-797a29256/)
- [ ] **[Add More Functionality]**
- [ ] **[Add Features]**
Contributions, issues, and feature requests are welcome!
If you like this project, I would like to Thank You!
Special Thanks to the Original design idea by Nelson Sakwa on Behance.
This project is [MIT](./MIT.md) licensed.