Xplore

Choose Your next Destination

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • 🚀 Live Demo
  • 🎥 Video Presentation
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

Xplore

Xplore is a web app built based on REST countries API, that provides information about countries via a RESTful API. This project collects information from The REST countries site and provide it in a simple organized way as a web app so that it can be applicable by travel agencies or for personal use to get info about a country or region easily. The App can also collect user information on the specific country as a comment and likes so that the app owner can get feedback from its customers.

🛠 Built With

Tech Stack

Key Features

• Provides detailed informatio on all countries
• collects user feedback in the form of comment and likes
• Responsive App

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

🎥 Video Presentation

• Video 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 web browser to view output e.g. Google Chrome.
• An IDE e.g Visual studio code.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

    "git clone https://github.com/Log-benjamin/Microverse-Javascript-Capstone/"

• Navigate to the location of the folder in your machine:

    cd ./desired_folder/

Install

Install all dependencies:

    "npm i"

Usage

To run the project, follow these instructions:

• Clone this repo to your local machine.
• then run it on your browser, run:

   " Open the index.html in the project directory with your preferred browser"

  Run tests

  To run tests, run the following command:

• HTML linter errors run:

  npx hint .

• CSS linter errors run:

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

• For unit testing, run:

  npm test

  Deployment

You can deploy this project using: GitHub Pages,

(back to top)

👥 Authors

👤 binyam tegene

• GitHub: @github
• Twitter: @twitte
• LinkedIn: LinkedIn

👤 Abbas Aljuaifari

• GitHub: @github
• Twitter: @twitter
• LinkedIn: LinkedIn

  (back to top)

🔭 Future Features

• We will add Frame work for the styling
• We will improve the Algorithm to make the app more efficent

(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 feel free to contact us, give us ⭐️ or make a contribution and share your ideas.

(back to top)

🙏 Acknowledgments

We would like to thank Microverse Inc and its community for the amazing learning opportunity.

Mr. FAYDER FLOREZ for very usefule open source RESTFUL Countries API.

Ms.kirti arora

(back to top)

📝 License

This project is MIT licensed.

(back to top)