shasherazi / countriesIndex

Countries Index is a web application that allows users to search for countries and get information about them. The information includes the country's name, capital, population, area, and flag and list of time zones. You can also filter the countries by continent.

Microverse README Template

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

📖 Countries Index

Countries Index is a web application that allows users to search for countries and get information about them. The information includes the country's name, capital, population, area, and flag and list of timezones. You can also filter the countries by continent.

🛠 Built With

Tech Stack

Client

• React.js

Key Features

• User can filter countries by continent
• User can see all countries on the home page
• User can see a country's details when they click on it

(back to top)

🚀 Live Demo

• Live Demo 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:

• Node.js
• NPM

Setup

Clone this repository to your desired folder:

    git clone [e-mail]:shasherazi/countriesIndex.git
    cd countriesIndex

Install

Install this project with:

    npm install

Usage

To run the project, execute the following command:

    npm start

Run tests

To run tests, run the following command:

    npm test

Deployment

You can deploy this project using:

    npm run deploy

(back to top)

👥 Authors

👤 Syed Hassan Askri

• GitHub: @shasherazi
• Twitter: @shasherazi
• LinkedIn: in/shasherazi

(back to top)

🔭 Future Features

• User can search for a country by name
• User can see a country's wikipedia page
• User can see a country's currency

(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 original design. You can see the original design here.

(back to top)

📝 License

This project is MIT licensed.

(back to top)