Metrics-web-app

📗 Table of Contents

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

📖 Metrics-web-app

This capstone project involves creating a mobile web application using React and Redux. The main objective is to develop a platform for monitoring a set of metrics (numerical values).

Metrics-web-app is a React-based project

🛠️ Built With

• HTML
• CSS
• JavaScript
• React
• Redux-toolkit

Tech Stack

Version Control

• Git Hub

Visual Studio Code

• Visual Studio Code

Client

• HTML5
• CSS
• JavaScript
• React

Key Features

• Linters SetUp
• Follow HTML and CSS best practice
• Follow React best practice
• Functional Components
• Import and Export Components
• Use Hooks
• Use react redux
• Use redux toolkit
• Use redux toolkit in Components
• Work with apis
• Add proper styles
• Add jest tests

(back to top)

🚀 Live Demo

• Live link

(back to top)

🦻 WalkThrough Video

• WalkThrough link

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

• Visual Studio Code.
• Node JS.
• Git bash.
• GitHub Account.

Setup

Clone this repository to your desired folder: Use git clone command or download ZIP folder

Install

Install this project with: npm Example command:

  cd Metrics-web-app
  npm init -y

Usage

To run the project, execute the following command: npm start or live server Example command:

  npm run build

Run tests

To run tests, run the following command: npm run test Example command:

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

Deployment

Deployed

(back to top)

👥 Author

👤 Yusuf Sholotan

• GitHub: @Yin-ka
• LinkedIn: Yusuf Sholotan

🔭 Future Features

• Adding Behaviors
  
• Making it stylish

(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 please follow me on github & twitter and also connect on Linkedin.

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for this exercise.
  
• Credits of the wonderfull design used goes to Nelson Sakwa the author of the original design thank you.
  

(back to top)

❓ FAQ (OPTIONAL)

• How long can it take to build that project

  • four days according to personal skills

• Where to find figma for that project!

  • Figma is not available for now!

(back to top)

📝 License

This project is MIT licensed.

(back to top)