/country-insights-hub

Primary LanguageJavaScriptOtherNOASSERTION

📗 Table of Contents

📖 [Country-insights-Hub]

[Country-insights-Hub] is a project that shows by default 10 countries with Names, Flags and Populations in the home page. And when you click on each of this countries, you will see more details about that country. Also you can search any country bt it's name in the search bar. This project fetched data from this https://restcountries.com API.

🛠 Built With

Tech Stack

Key Features

  • [Responsive layout]

(back to top)

🚀 Live Demo

Watch the live demo at the following link: https://www.loom.com/share/99e0a9f2f2f3474cb37233c5173185dc?sid=ee4fcd33-6e69-45df-a2f5-b148091d1819

(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 of you choice.
  • A text editor of your choice.
  • An installed node.js on your local system

Setup

Clone this repository to your desired folder:

  • Use the following Commands:

    cd your-desired-folder
    git clone https://github.com/78fatemanazari/country-insights-hub.git
    

Install

  • Install this project with:

     npx create-react-app .
     cd "your project folder name"
     npm start
    

Usage

  • Use the following commands to run the project on your local system:

    npm run build
    npm run deploy
    

Run tests

  • Run the following script and style test:

    npx eslint "**/*.{js,jsx}"
    npx eslint "**/*.{js,jsx}" --fix
    
    npx stylelint "**/*.{css,scss}"
    npx stylelint "**/*.{css,scss}" --fix
    

Deployment

  • 1- install gh-pages with following command:

    npm i -D gh-pages
    
  • 2- Add the following scripts to the package.jason file:

    "predeploy": "npm run build",
    "deploy": "gh-pages -d build ",
    
  • 3- Run the following command:

    npm run deploy
    

(back to top)

👥 Author

👤 Fatema Nazari

🔭 Future Features

  • [Build desktop version]
  • [work on styles]
  • [Add animations and transitions]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project, give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank Nelson Sakwa for his beautifull and best design on Behance. I would like to thank Microverse and my coding partners.

(back to top)

❓ FAQ (OPTIONAL)

(back to top)

📝 License

This project is MIT licensed.

(back to top)