📗 Table of Contents

• 📗 Table of Contents
• 📖 [Metric WebApp]
  • Screenshots
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Metric WebApp]

[Metric WebApp] is a react based responsive web application that allows users to view countries around. The web app has two pages: the home page and the details page. The home page displays a list of countries that could be filtered by country name. When the user clicks (or taps) on a country, the application navigates to the details page.

Screenshots

🛠 Built With

Tech Stack

• React
• Redux
• Redux-router
• Linters (ESLint, Stylelint)
• Jest
• Design Credits to Nelson Sakwa on Behance
• financialmodelingprep API

Key Features

• [Home page that displays list of Countries]
• [Details page for detailed information about a Country]
• [Back button to navigate back to the home page from the details page]

(back to top)

🚀 Live Demo

• Live Demo Link
• Presentation

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

  a browser
  a code editor

Setup

Clone this repository to your desired folder:

  cd your-folder
  git clone https://github.com/kennedyowusu/metrics-webapp

Install

Install this project with:

  cd metrics-webapp
  npm install

Usage

To run the project, execute the following command:

  npm run build
  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project using:

npm start

(back to top)

👥 Author

👤 Kennedy Owusu

• GitHub: @kennedyowusu
• Twitter: @_iamkobby
• LinkedIn: Kennedy Owusu

(back to top)

🔭 Future Features

• [Generate and display more data about a country]
• [Add the tourists sites within a country]
• [Authenticate users before viewing homepage]

(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

I would like to thank Nelson Sakwa on Behance for the design inspiration.

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