/metrics-webapp

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

Primary LanguageJavaScriptMIT LicenseMIT


World Info README Template

📗 Table of Contents

📖 World Info

World Info metrics web app is a React project developed as part of Microverse React solo project activity. The project is developed using React and Redux toolkits. Data is obtained from API. On this web page, the User can see information about each country in the world (capital city, population, currencies, timezone and local time and date)

🛠 Built With

Key Features

  • API
  • React
  • CSS

(back to top)

🚀 Live Demo and project presentation

(back to top)

💻 Getting Started

To get the local copy up and running, follow these steps.

-Clone the Repo or Download the Zip file or https://github.com/TamaraDimov/metrics-webapp.git

-cd /leaderboard

-Open it with the live server

Prerequisites

In order to run this project you need:

-Git/Github -React and CSS knowledge -VS code or any other equivalent tool.

Setup

Clone this repository to your desired folder:

Install

To install locally run git clone https://github.com/TamaraDimov/metrics-webapp.git

-Open the cloned directory with VSCode

-Install live server extension for VSCode

-Right click on the index.html and select open with live servers

Run tests

To run tests, run the following command:

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

After cloning the project you need to run these commands

  • npm install

This command will download all the dependancies of the project

For tracking linter errors in HTML files run:

  • npx hint .

For tracking linter errors in CSS or SASS files run:

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

And For tracking linter errors in JavaScript files run:

  • npx eslint .

(back to top)

👥 Authors

👤 Tamara Dimov

(back to top)

🔭 Future Features

  • Location
  • Country Area

(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 give it a ⭐️

(back to top)

🙏 Acknowledgments

We would like to thank Nelson Sakwa the author of the original design and Microverse for granting me the knowledge to do this.

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

  • Can you add country area to the detail page?

    • Sure, I will add that ASAP :)

  • Great page!

    • Thank you very much

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)