Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/til2to/country-pulse

CountryPulse is a web app that displays a list of countries from an API.
https://github.com/til2to/country-pulse

Last synced: 6 days ago
JSON representation

CountryPulse is a web app that displays a list of countries from an API.

Host: GitHub
URL: https://github.com/til2to/country-pulse
Owner: til2to
License: mit
Created: 2023-06-26T14:25:41.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-07-08T17:33:36.000Z (over 1 year ago)
Last Synced: 2024-12-09T16:52:51.541Z (16 days ago)
Language: JavaScript
Size: 7.51 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

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](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 COUNTRY PULSE 

**COUNTRY PULSE** is a web app that displays a list of countries from the REST Countries API.

## 📷 [Screenshots]



  



## 🛠 Built With 

### Tech Stack 

  Client

  


    React.js

    Redux

    Tailwindcss

    Axios

  


### Key Features 

- **Homepage - Dispalys all continents**

- **Continent Page - Displays total number of countries and lists all countries in that continent**

- **Search for a country - Search for a country on the continent page**

- **Country Details - Displays details of a particular country**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://64a007b822c0772073878a88--merry-dango-effcc0.netlify.app/)

(back to top)


## 🎥 Video Presentation

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

- Latest version of [Node](https://nodejs.org/en/) installed on the computer.

- [Git](https://git-scm.com/downloads) installed on the computer.

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone https://github.com/til2to/country-pulse.git

```

### Install

Install this project with:

```sh

  cd country-pulse

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm start

```

### Run tests

To run tests, run the following command:

```sh

  npm test

```

### Deployment

You can deploy this project using:

- [Vercel](https://vercel.com/docs)

(back to top)


## 👥 Authors 

👤 **Owusu Dennis Prah**

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

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/dennis-owusu-prah-835888206/)

(back to top)


## 🔭 Future Features 

- [ ] **Display data for every subregion**

(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, give it a ⭐

(back to top)


## 🙏 Acknowledgments 

I would like to thank

- [Microverse](https://www.microverse.org/)

- [Nelson Sakwa on Behance](https://www.behance.net/sakwadesignstudio)

- [REST Countries API](https://restcountries.com/)

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)