/react-capstone

Primary LanguageJavaScriptMIT LicenseMIT

Covid19 Global Rates

πŸ“— Table of Contents

πŸ“– "Covid-19 Global Rates"

Web application that allows the user to see the Covid-19 statistics from different countries around the world. The app has 3 pages:

  • The home: where you can see a list of the continents with their respective image, name, and total cases. Also, there is a search input where you can type the country’s name and go directly to its detailed information.
  • The countries: when you click on any continent, the countries pages display a list of all the countries of that continent. Each country counts with its name, flag, and total cases.
  • The details: when you click on any country the details page displays the population, total cases, deaths, and recovered.

The design was taken from Nelson Sakwa on Behance, according to the Creative Commons license of the design for more details move to the Acknowledgements section

πŸ›  Built With

Tech Stack

CSS
  • The CSS is used to provide the design in the whole page.
Linters
  • The Linters are tools that help us to check and solve the errors in the code
  • This project count with two linters:
    • CSS
    • JavaScript
React
API

Key Features

  • SPA
  • Simple interface
  • React App
  • React Router
  • Redux Toolkit
  • Implementation of react-redux
  • Test with Jest & React Test Library

(back to top)

πŸš€ Live demo

Live demo

(back to top)

πŸ“Ή Video presentation

Video

(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:

  • To have a Git in your device : this is in order to clone and modify this project.
  • To have a code editor : such as VS code, Atom or another that you would like to use.
  • To have a web local server such as XAMPP : this is in with the purpose of you will be able to watch the changes you make in the project.
  • Have basic knowledge about HTML, CSS and JSX in order to understand the code and be able to modify the elements you want.
  • Count with Node.js in your device due to it is a tool needed to run the linters

Setup

Clone this repository to your desired folder:

  • Clone this repo on your local device you need to open Git Bash and paste the link with the command
  cd my-folder-name
  $ git clone https://github.com/AndreaM2429/react-capstone

Install

In order can run the linters tools you need use the following commands in your local work environment:

npm install i

Note: About the live server server you need to run the following command inside the project.

npm start

Usage

Now you are able to modify the files in the src/, but be careful just modify them, the rest are for the funcionality of the app so NOT MODIFY THEM.

Run tests

To see the linter errors run the following codes for:

npm run test

  • CSS
 npx stylelint "**/*.{css,scss}"
  
 To fix the errors add --fix
  • JS
 npx eslint "**/*.{js,jsx}"
  
 To fix the errors add --fix

Available Scripts

In the project directory, you can run:

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.

Deployment

To deploy this project by someone who isn't the owner is prohibit.

(back to top)

πŸ‘₯ Author

πŸ‘€ Andrea Manuel

(back to top)

πŸ”­ Future Features

  • Made a more complex disaign and implement animations

(back to top)

🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page and add your thoughts

(back to top)

⭐️ Show your support

If you like this project you could clone the repo and work with it or do the changes in a new branch. Also you could let a message with your thoughts

(back to top)

πŸ™ Acknowledgments

I’m not the original author of the design, it was taken from Nelson Sakwa on Behance, I take the fonts, color, and layout from his Ballhead App (Free PSDs). I want to thank him, so please go to his profile and support the original designer.

(back to top)

πŸ“ License

This project is MIT licensed.

(back to top)

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: 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

Making a Progressive Web App

This section has moved here: 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

Deployment

This section has moved here: 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

(back to top)