devalibello/kano-weather-app

Kano Weather Application

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Kano Weather Application]

[Math Magician] This is a webapp that can be used to display various weather conditions of Kano State - Nigeria. The app was built using React/Redux Toolkit with the aid OpenWeatehr API.

🛠 Built With

Tech Stack

This project was built using HTML, CSS and Javascript

Client

• HTML
• CSS
• Javascript

Key Features

• [ Renders the current weather condition in real time ]
• [ API calls to OpenWeather API]
• [ Uses React/Redux Toolkit]

(back to top)

💻 Presentation

Click for presentation Kano Weather Application Presentation.

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

-a code editor installed that can run HTML and CSS files -linters installed and fully functional

Setup

Clone this repository to your desired folder. Use the command: git clone https://github.com/devalibello/kano-weather-app.git

Install

Install this project with:

1. Install ESLint: npm install --save-dev eslint@7.x eslint-config-airbnb@18.x eslint-plugin-import@2.x eslint-plugin-jsx-a11y@6.x eslint-plugin-react@7.x eslint-plugin-react-hooks@4.x @babel/eslint-parser@7.x @babel/core@7.x @babel/plugin-syntax-jsx@7.x @babel/preset-react@7.x @babel/preset-react@7.x

2. Install StyleLint: npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

Usage

To run the project, execute the following command:

• open cloned folder in your code editor and run the index.html file

Run tests

To run tests, run the following command:

To check for CSS or SCSS errors:

• With linters correctly installed, npx stylelint "*/.{css,scss}"

• To fix CSS or SCSS linters error: npx stylelint "*/.{css,scss}" --fix

To check for javascript errors:

• With linters correctly installed,

• npx eslint "**/*.{js,jsx}"

• To fix react linters error:

• npx eslint "**/*.{js,jsx}" --fix

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Ali Bello Imoukhuede

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Include other state in Nigeria to the webapp]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, kindly share my github repo with your friends and follow me on the various social media platforms

(back to top)

🙏 Acknowledgments

I would like to thank the developers of react/redux toolkit and also OpenWeather API.

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)