admirerbrown/Nation-Teller

This React capstone project is about building a mobile web application to check a list of country metrics.The project is a single-page application (SPA) built with React and Redux. The data retrieved from the RestCountries API is stored in the Redux store. Every page (the main page and the pages for each item) have a unique route within the SPA.

📖 Nation-Teller

This React capstone project is about building a mobile web application to check a list of country metrics.The project is a single-page application (SPA) built with React and Redux. The data retrieved from the RestCountries API is stored in the Redux store. Every page (the main page and the pages for each item) have a unique route within the SPA.

📗 Table of Contents

• 📖 Nation-Teller
• 📗 Table of Contents
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 🚀 Video Walk Through
  • 💻 Getting Started
    • Prerequisites
    • Install
    • Usage
    • Testing
    • Deployment
  • Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

🛠 Built With

Tech Stack

• HTML
• CSS
• JavaScript
• React
• [Redux]

Server

• Render

Database

• API

Key Features

HomePage When the page loads, the webapp shows the list of categories that could be filtered out by some parameter, for example by the country name.

DetailsPage In the details page, the webapp retrieves data from the API to show detailed data in the category. When the user clicks on the "Back" button (<), the user navigates to the home page.

SearchPage Displays filtered list of country depending on the users search parameter.

(back to top)

🚀 Live Demo

• click here

(back to top)

🚀 Video Walk Through

• click here

(back to top)

💻 Getting Started

• Open GitHub URL of repository.

• Download Code repo in zip.

• Extract and open repo folder into visual studio code or any other Text Editor Software.

• GitHub Repository URL: https://github.com/admirerbrown/Covid-Rat.git To get a local copy up and running follow these simple example steps.

  git clone https://github.com/admirerbrown/Nation-Teller.git

Prerequisites

• Visual Studio Code
• Knowledge About HTML / CSS / JAVASCRIPT ES6
• Webhint
• Stylelint
• ESLint
• node_modules checker
• Github

Install

Install this project with:

  npm install

Usage

To run the project in a development server, execute the following command:

  npm start

Testing

To run the tests in a development server, execute the following command:

  npm test

Deployment

You can deploy this project using: Render, or Netlify

(back to top)

Author

👤 Samuel Kyere

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• ** I would like to Make the website provide information on all countries in the world**
• ** improve search or filter functionality to improve search results

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please follow me on github and give stars to my repo.

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for providing - this inspirational resource used for the project.
• Again i would like to thank creative commons for helping designers make resources freely available.
• Original design idea by Nelson Sakwa.

(back to top)

📝 License

This project is MIT licensed.

(back to top)