Chimoneg27/in-the-air

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Space Travelers' Hub]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • npm start
    • npm test
    • npm run build
    • npm run eject
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [In The Air]

"In The Air" is working with the real live data from the open weather API.This application keeps track of air toxicity levels across the worlds' major cities.

🛠 Built With

Tech Stack

Client

• React.js
• JSX
• React Components
• React Router V6
• CSS
• Redux Toolkit
• Bootstrap

Key Features

• Built with React JS
• Single page app
• Redux store with reducers
• Neat folder structure
• Redux toolkit for state management
• Neat user interface
• Responsive design
• Live demo

(back to top)

🚀 Live Demo

• In The Air

• Video walkthrough

(back to top)

💻 Getting Started

• Open your Terminal
• Navigate to the desired directory to which you want to clone the repository to
• [Copy & Paste] git clone https://github.com/Chimoneg27/in-the-air.git

Prerequisites

In order to run this project you need:

• Basic understanding of Github
• Basic understanding of run project by npm
• Your machine should have Chrome or any of your favorite browsers and VSCode installed

Setup

Clone this repository to your desired folder:

• git clone https://github.com/Chimoneg27/in-the-air.git

Install

Install this project with:

npm install

Usage

To run the project, execute the following command:

npm start

Runs the app in the development mode.
Open 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 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.

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.

Run tests

To run tests, run the following command:

  npx stylelint "**/*.{css,scss}"

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

Deployment

• You can deploy it using: Render

(back to top)

👥 Authors

👤 Author Garvin

• GitHub: @Chimoneg27
• Twitter: @GarvinChimone
• LinkedIn: Garvin Chimone

(back to top)

🔭 Future Features

• Add more cities
• Add pagination

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project! It's help a lot

(back to top)

🙏 Acknowledgments

• Nelson Sakwa for the website design layout.
• OpenWeatherApi for the amazing API.

(back to top)

📝 License

This project is MIT licensed.

(back to top)