📗 Table of Contents

• 📖 About the Project
• 🛠 Built With
  • Tech Stack
• Key Features
• Future Features
• 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
• 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgements
• 📝 License

Covid-Info

Covid Info App is an initiative aimed at providing accurate statistics and reports about the coverage and cases of the pandemic in all regions of the world. It utilizes mobile-friendly user interfaces delivering amazing experiences to users.

🛠 Built With

This project was built with;

• HTML
• CSS
• Javascript
• React
• Redux
• Jest

Tech Stack

Technologies used

• GitHub
• Visual Studio Code
• GitBash
• Webpack

Client

• React.js

Key Feature

• Fetches Covid-19 prevalence data by continent
• Users can search on a continent basis
• Users can view Covid-related details of chosen continents
• Use of conditional rendering to abstract the supposed complexity of the app
• The app is a Single Page Application (SPA)

Future Features < a name="future-features">

In the future, I hope to work on the possibility of users being able to:

• Login
• Save preferred information
• Narrow their search to Countries, states, and regions in addition to the current cumulative for each continent.

(back to top)

Live-Demo

Follow this link to view the live demo of the app 🌐

Recorded video

A visual tour of the features of the app can be found here. I hope you'll enjoy it.

💻 Getting Started

In order to use the project files, Kindly follow these steps:

Steps

• To clone the project select the desired directory in cmd and run: git clone https://github.com/AbayomiOlaoye/covid-info.git
• Install npm dependencies: npm install
• To check the live preview: npm run start
• For StyleLint test, run: npx stylelint "**/*.{css,scss}"
• For WebHint test, run: npx hint .
• For EsLint test, run: npx eslint .

Prerequisites

• Have basic level knowledge of HTML/CSS/JS/ES6/React/Redux
• Have basic level knowledge about linters/Webpack
• Have basic level knowledge about the working of the website

Setup

1. Download the Zip file or clone the repo with:

git clone https://github.com/AbayomiOlaoye/covid-info.git

2. To access cloned directory run:

cd covid-info

Install

To install linters, react and other project dependencies run:

npm install

Run

1. To run this project :
npm start
2. open the urs localhost:8080 on your browser

npm run build

Builds the app for production to the build folder.\

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.

npm test

Launches the test runner in the interactive watch mode for React.\

Run Test for Linters

For tracking linter errors locally you need to follow these steps:

1. For tracking linter errors in HTML files run:

npx hint .

2. For tracking linter errors in CSS or SASS files run:

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

3. For tracking linter errors in JavaScript files run:

npx eslint .

Authors

👤 Oluwatoyin Olaoye

GitHub | Twitter | LinkedIn

⭐️ Show your support

Give a ⭐️ if you like this project!

🙏 🙏 Acknowledgments

• Thanks to @Nelson Sakwa for the templates and insights to a more enhanced documentation approach.

(back to top)

📝 License

This project is MIT licensed.

(back to top)