https://github.com/oscarfmdev/countries-info
Countries Info is a Single Page Application, the user can search for countries and click on any flag to know more about this country.
https://github.com/oscarfmdev/countries-info
api-rest react redux
Last synced: about 2 months ago
JSON representation
Countries Info is a Single Page Application, the user can search for countries and click on any flag to know more about this country.
- Host: GitHub
- URL: https://github.com/oscarfmdev/countries-info
- Owner: OscarFMdev
- License: other
- Created: 2022-11-22T00:52:30.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-11-26T15:48:51.000Z (over 3 years ago)
- Last Synced: 2023-03-12T01:06:37.512Z (over 3 years ago)
- Topics: api-rest, react, redux
- Language: JavaScript
- Homepage: https://oscarfmdev-countries.netlify.app/
- Size: 2.33 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Microverse README Template
# 📗 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 Info]** is a Single Page Application, the user can search for countries and click on any flag to know more about this country.
Client
Storage
API
- **Single Page Application**
- **The user can filter the countries and click to see more about the country.**
- **The app uses React and calls an API to get the information and store it using Redux**
- [Live Demo Link](https://oscarfmdev-countries.netlify.app/)
- [Live Video](https://www.loom.com/share/eaebc1690e674db085ed3b2ebeb1d763)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
To have installed [node.js](https://nodejs.org/en/download/) and [Git](https://git-scm.com/downloads)
### Setup
Clone this repository to your desired folder:
First enter the folder you want to save the project.
```sh
cd my-folder
```
After moving into the directory you want to save the project you could clone it using the terminal.
```sh
git clone git@github.com:OscarFMdev/countries-info.git
```
### Install
Install this project with:
```sh
cd space-travelers-hub
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 run test
```
👤 **Author: Oscar Fernández Muñoz**
- GitHub: [@OscarFMdev](https://github.com/OscarFMdev)
- Twitter: [@oscarfmdev](https://twitter.com/oscarfmdev)
- LinkedIn: [LinkedIn](https://linkedin.com/in/oscarfmdev)
- [ ] **Update styling based on feedback.**
- [ ] **Add more information about each country.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project show your support giving a ⭐.
I would like to thank:
- [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) [for his design](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs))
- [REST Countries API](https://restcountries.com/) for making this project possible.
- **How can I use this API?**
- You can use the search bar or scroll to find the country you're interested on learning more about and click on the flag to display the country's information.
- **Can I contribute to this Single Page Application?**
- For sure! I'm always happy to meet new developers, and I'd love to work together 🙌.
This project is [MIT](./LICENSE) licensed.