Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/meryemsanem/countries-capstone-project

"Explore The Countries" is a web application built using React and Redux that displays information about different countries. It consists of the following main pages: Homepage and Details. The project provides a user-friendly interface for users to search, sort, and view details about different countries.
https://github.com/meryemsanem/countries-capstone-project

Last synced: 2 days ago
JSON representation

"Explore The Countries" is a web application built using React and Redux that displays information about different countries. It consists of the following main pages: Homepage and Details. The project provides a user-friendly interface for users to search, sort, and view details about different countries.

Awesome Lists containing this project

README

        


Explore The Countries πŸ—ΊοΈ

# 🌎 Table of Contents

- [ Table of Contents](#table-of-contents)
- [🌎 Explore The Countries ](#about-project)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸš€ Live Demo ](#live-demo-)
- [πŸ’» Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [`npm start`](#npm-start)
- [`npm test`](#npm-test)
- [`npm run build`](#npm-run-build)
- [`npm run eject`](#npm-run-eject)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ License ](#-license-)

# 🌎 Explore The Countries

**"Explore The Countries"** is a web application built using React and Redux that displays information about different countries. It consists of the following main pages: **Homepage and Details.**
The project provides a user-friendly interface for users to search, sort, and view details about different countries. It makes use of modern React and Redux practices to manage state and fetch data from an external API.

## πŸ›  Built With

### Tech Stack

Client

### Key Features

- Fetch the countries and display the details of them.
- Sort the displayed countries in ascending or descending order based on their names.
- It provides a search functionality to filter countries based on the entered search text.

(back to top)

## πŸš€ Live Demo

- [Live Demo Link](https://explore-the-countries.onrender.com/)

(back to top)

## Presentation

- [Presentation Link ](https://www.loom.com/share/42cf532992ba47b5b710d64fc7b040f2?sid=8009f0bb-5c7f-41aa-8a06-43efb081101c)

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

- Node.js
- npm

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/meryemsanem/countries-capstone-project.git
```

### Install

Install this project with:

```sh
cd countries-capstone-project
npm install
```

### Usage

To run the project, execute the following command:

### Webpack Development Server

To run the webpack development server, execute the following command:

```bash
npm start
```

### To track CSS linter errors, run:

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

- To track JavaScript linter errors, run:

```bash
npx eslint "**/*.{js,jsx}"
```

### Build

To build the project, run the following command:

```bash
npm run build
```

### Run tests

To run tests, run the following command:

```sh
npm test
```

### Deployment

- You can deploy it using: Github Pages

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Meryem Sanem Küçükbayram**

- GitHub: [@meryemsanem](https://github.com/meryemsanem)
- LinkedIn: [@meryemsanem](https://www.linkedin.com/in/meryemsanemkucukbayram/)

(back to top)

## πŸ”­ Future Features

- **Login page**
- **More details of the countries**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/meryemsanem/countries-capstone-project/issues).

(back to top)

## ⭐️ Show your support

If you find this project helpful or interesting, star this repository on GitHub to let me know you like the project. ⭐️

(back to top)

## πŸ™ Acknowledgments

Special thanks to **Nelson Sakwa** who has the owner of the design.

(back to top)

## πŸ“ License

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

(back to top)