https://github.com/sumon766/countries-navigator

https://github.com/sumon766/countries-navigator

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sumon766/countries-navigator
• Owner: sumon766
• Created: 2023-05-09T10:07:53.000Z (over 1 year ago)
• Default Branch: development
• Last Pushed: 2023-10-17T14:16:33.000Z (over 1 year ago)
• Last Synced: 2024-10-21T19:38:06.403Z (3 months ago)
• Language: JavaScript
• Size: 3.97 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Countries Navigator 

**Countries Navigator** is a project where all the countries basic information can be found. In this site, a user can see the list of all countries, filter them according to the continents and check which countries are in which continent. Also, one can navigate to a single country details page and see the details like area, population, latitude, longitude, currencies of a country. 

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React.js

    
Redux.js

  


  Router

  


    
React Router

  


  Testing Library

  


    
React Testing Library

    
Jest

  


### Key Features 

- **List of Countries**

- **View Countries by Continent**

- **See Details of a Country**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://sumon766.github.io/countries-navigator/)

- [Project video Link](https://www.loom.com/share/555478c04e1540f2b292b928d8d29cf1)

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

### Setup

Clone this repository to your desired folder:

Example commands:

```sh

  cd my-folder

  git clone https://github.com/sumon766/countries-navigator.git

```

-

### Install

Install this project with:

Example command:

```sh

  cd my-project

  npm install

```

-

### Usage

To run the project, execute the following command:

Example command:

```sh

  npm run build

  npm start

```

-

### Run tests

To run tests, run the following command:

Example command:

```sh

  npm test

```

-

### Deployment

You can deploy this project using:

Any server, github pages, netlify, vercel

(back to top)


## 👥 Authors 

👤 **Mursedul Islam Sumon**

- GitHub: [@githubhandle](https://github.com/sumon766)

- Twitter: [@twitterhandle](https://twitter.com/sumon766)

- LinkedIn: [LinkedIn](https://linkedin.com/in/sumon766)

(back to top)


## 🔭 Future Features 

- [ ] **Add more details to a country**

- [ ] **Filter countries by sizes**

- [ ] **Financial details of a country**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project feel free to give me a star. Or if you want, you can buy me a coffee.

(back to top)


## 🙏 Acknowledgments 

I would like to thank microverse for providing such an amazing project. Also, the user interface design credit goes to [Nelson Sakwa](https://www.behance.net/sakwadesignstudio), thanks to him.

(back to top)


## 📝 License 

This project is [MIT](https://github.com/sumon766/countries-navigator/blob/main/LICENSE.md) licensed.

(back to top)