README.md

Metrics Webapp

📗 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
• 📝 License

🎯 Metrics Webapp

This React capstone project is about building a mobile web application to check a list of metrics (numeric values) that make by use of React and Redux.

🛠 Built With

Tech Stack

Technology

• React
• SCSS
• Redux
• Redux Toolkit
• React Router Dom

Tools

• VS Code
• GIT
• GITHUB

Key Features

This project is a simple metrics app. The main features are:

• Mainly consists of two page:
• Home page with a list of regions and countries of that region that could be filter
• Detail page for the country details; in the example, the detail page for Czech Republic cities with number of views.

(back to top)

🚀 Live Demo

presentation_video.mp4

• Live Demo Link
• Presentation slide
• Presentation Link

(back to top)

💻 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

you have to those tools in your local machine.

• NPM
• GIT & GITHUB
• Any Code Editor (VS Code, Brackets, etc)

Setup

Clone the project.

  git clone [email protected]:shahadat3669/metrics-webapp.git

Go to the project directory.

  cd metrics-webapp

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.

Your app is ready to be deployed!

See the section about deployment for more information.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

(back to top)

👥 Authors

First Author:

Shahadat Hossain

(back to top)

🔭 Future Features

• We will implement city details page

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

(back to top)

🔭Acknowledgments

• My Family.
• Microverse Team.
• Rest Countries API
• Original design idea by Nelson Sakwa on Behance.

(back to top)

❓ FAQ

• Are you using database?

  • No, I am not using any database.

• Can I use this project for personal use?

  • Yes, you can use it.

(back to top)

📝 License

This project is MIT licensed.

(back to top)