README

📗 Table of Contents

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

📖 REACT METRIC WEBAPP

REACT METRIC WEBAPP is a mobile webApp that contains Vibranium mineral annual revenue, displaying them in segment of year, and into a smaller segment of each country revenue.

🛠 Built With

• REACT
• CSS
• REDUX

Tech Stack

Client

• REACTJS

style

• CSS

state management

• REDUXJS

Key Features

• receive data from an API using await fetch
• manage state using redux
• create a Home page to display the yearly data
• Create a page for each data using useparams.

🚀 Live Demo

• Live Demo Link

(back to top)

Video Presentation

Video Presentation

💻 Getting Started

Prerequisites

• git: A tool for managing source code
• Visual Studio Code: A source code editor

Setup

Clone this repository to your desired folder: https://github.com/AyomipoMajek/react-capstone.git

Example commands:

  cd my-folder
  git clone git@github.com:myaccount/Module2_capstune_Project.git

Install

• Run npm install after cloning the repo

install npx

Example command:

  cd my-project
  npx install

Usage

• Run npm start for development.
• Run npm run build for production

Run tests

To run tests, run the following command:

• Run npx eslint . for JS check
• Run npx eslint . --fix to fix JS errors if found
• Run npx stylelint "**/*.{css,scss}" for CSS check
• Run npx stylelint "**/*.{css,scss}" --fix to fix CSS errors if found.

Deployment

You can deploy this project using:

• Github pages

Github pages

follow these steps for example

(back to top)

##👥 Authors

👥 Authors

👤 Ayomipo Majek

• GitHub: @AyomipoMajek

(back to top)

🔭 Future Features

• Deploy

(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 take the time to give a star, follow us and a feedback, we will appreciate it.

(back to top)

🙏 Acknowledgments

I would like to thank microverse for the great resources shared. Also I would like to thanks Nelson Sakwa on Behance for Original Design Official.

(back to top)

📝 License

This project is MIT licensed.

(back to top)