Tell the Clouds

📗 Table of Contents

• 📗 Table of Contents
• 📖 Tell the Clouds
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Tell the Clouds

Tell the Clouds is a weather app designed to provide users with up-to-date weather information for various states in Nigeria. Here's a brief video introducing you to the project.

🛠 Built With

Tech Stack

Client

• React.js
• Redux Toolkit

Key Features

• Filter through list of location
• Get up-to-date weather information

(back to top)

🚀 Live Demo

• Live Demo Link

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• node
• npm
• API Key **Note: To use API Key, add the following to your .env file:

REACT_APP_WEATHER_API_KEY = 'add-your-api-key-here'

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:wineshuga/tell_the_clouds.git

Install

Install this project with:

  cd my-project
  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project using:

  npm build

(back to top)

👥 Authors

👤 Nweneary Uzochukwu Winnie

• GitHub: @Wineshuga
• Twitter: @Wineshuga
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Cover wider regions
• Cover more specific regions

🤝 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, please give this project star⭐.

🙏 Acknowledgments

I would like to thank Microverse for inspiring this project and Nelson Sakwa for the original design idea on Behance.

📝 License

This project is MIT licensed.

(back to top)