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
• ❓ FAQ
• 📝 License

📖 [Countries Info]

[Countries Info] is a Single Page Application, the user can search for countries and click on any flag to know more about this country.

🛠 Built With

Tech Stack

Client

• React.js

Storage

• Redux

API

• REST Countries

Key Features

• Single Page Application
• The user can filter the countries and click to see more about the country.
• The app uses React and calls an API to get the information and store it using Redux

(back to top)

🚀 Live Demo

• Live Demo Link

🚀 Video Demo

• Live Video

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

To have installed node.js and Git

Setup

Clone this repository to your desired folder:

First enter the folder you want to save the project.

  cd my-folder

After moving into the directory you want to save the project you could clone it using the terminal.

  git clone git@github.com:OscarFMdev/countries-info.git

Install

Install this project with:

  cd space-travelers-hub
  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm run test

(back to top)

👥 Authors

👤 Author: Oscar Fernández Muñoz

• GitHub: @OscarFMdev
• Twitter: @oscarfmdev
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Update styling based on feedback.
• Add more information about each country.

(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 show your support giving a ⭐.

(back to top)

🙏 Acknowledgments

I would like to thank:

• Nelson Sakwa for his design
• REST Countries API for making this project possible.

(back to top)

❓ FAQ

• How can I use this API?

  • You can use the search bar or scroll to find the country you're interested on learning more about and click on the flag to display the country's information.

• Can I contribute to this Single Page Application?

  • For sure! I'm always happy to meet new developers, and I'd love to work together 🙌.

(back to top)

📝 License

This project is MIT licensed.

(back to top)