zikazaki / countries-info

A countries app that pulls from the REST Countries API to allow users to get information about any country worldwide. Built with React & Redux.

Countries-Info

This web application is built upon real live data from the REST Countries API. The main purpose is to build a web application that provides all sorts of useful information about every country. It includes data from ISO 3166 (countries and states/subdivisions ), ISO 4217 (currency), and E.164 (phone numbers). The application will allow users to get information about any country they're willing to visit.

Built With ⚙️

• Major languages: HTML, CSS, & JavaScript.
• Frameworks: React & Redux.
• Linters: Lighthouse, Webhint, Stylelint & ESLint.
• Technologies used: NPM, Webpack, & Jest Library.
• Tools: Git, Gitflow, GitHub, Netlify, VS Code, & Chrome Browser.

Live Demo (Deployed On Netlify) 🚀

Live Demo Link

Video Link (Recorded by Loom) 📹

Video Link

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Basic Knowledge of HTML, CSS, & JavaScript.
• Basic knowledge of React fundamentals.
• Basic knowledge of Redux fundamentals.
• Basic knowledge of ES6 syntax.
• Basic knowledge of Git & GitHub.
• Basic knowledge of Linters.
• Basic knowledge of Webpack.
• Basic knowledge of Jest unit-testing library.
• Basic knowledge of VS Code or any other code-editors.

Setup

• Create a new Microverse folder and move into it.
• Open the Command Prompt (CMD) in the current directory (Microverse Folder).
• Run the following command:

$ git clone https://github.com/ZikaZaki/countries-info.git

• Once finished you should see a new folder called countries-info folder in your current directory.
• Start customizing the project so it fits your personal preferences and needs.
• Enjoy your new professional Countries-Info application!

Install Dependencies

To check for linters, use the files provided by Microverse. A GitHub action is also set to run during pull request. Run the following command to install dependencies:

$ npm install

Run tests

We used the Jest & React-testing libraries for testing the project.

$ npm run test

Authors

👤 Zakariya Al-Khamisi (ZikaZaki)

• GitHub: ZikaZaki
• Twitter: Zakariya Al-Khamisi
• LinkedIn: Zakariya Al-Khamisi

Show your support

Give a ⭐️ if you like this project!

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Acknowledgments

• Microverse
• REST Countries API.
• Nelson Sakwa for his amazing Ballhead App design on Behance.
• Code Reviewers & Coding Partners
• Hat tip to anyone whose code was used
• Inspiration
• etc

📝 License

This project is MIT licensed.