https://github.com/bornittah/countries-api

https://github.com/bornittah/countries-api

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bornittah/countries-api
• Owner: Bornittah
• License: mit
• Created: 2023-01-07T03:18:08.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-14T20:16:19.000Z (about 2 years ago)
• Last Synced: 2023-03-04T05:09:39.115Z (almost 2 years ago)
• Language: JavaScript
• Size: 422 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  
countries-api




# 📗 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)

# 📖 [countries-api] 

**[countries-api]**is a web application that shows major regions and countries in the world. It fetches data from REST COUNTRIES API



## 🛠 Built With 

HTML, CSS, Es6 Javascript

### Tech Stack 

  Client

  


    
React Redux

  


### Key Features 

>Here are the key features of the application.

- Fetches data from the rest countries API

- Displays a home page with different regions in the world

- Allows users to click on each region to view detailed  information

- Search bar to filter regions, countries by name

(back to top)


## 🚀 Live Demo 

[Live Demo Link](https://countriesapi.onrender.com/)

(back to top)


## 🚀 Video Presentation 

[Video Presentation Link](https://www.loom.com/share/5992228604784bc596ca0b50830df0c9)

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

Github, CSS, Javascript, Code editor, Browser, Internet

### Setup

Clone this repository to your desired folder:

Run `git clone [url](https://github.com/Bornittah/countries-api.git)`

### Install

Install this project with:

`npm install`

### Usage

To run the project, execute the following command:

`npm start`

### Run tests

To run tests, run the following command:

`npm test`

### Deployment

You can deploy this project using:

`npm deploy`

(back to top)


## 👥 Authors 

👤 **Author1**

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

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

- LinkedIn: [Bornittah](www.linkedin.com/in/agasha-bornittah)

(back to top)


## 🔭 Future Features 

- [ ] **Implement settings**

- [ ] **Add search by microphone**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Bornittah/countries-api/issues).

(back to top)


## ⭐️ Show your support 

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

I would like to thank all the code reviewers for their feedback

(back to top)


## ❓ FAQ 

- **[How to create anew react app]**

  - [Refer to this documentation](https://reactjs.org/docs/create-a-new-react-app.html)

(back to top)


## 📝 License 

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

(back to top)