Git Product home page Git Product logo

katarighe / capstone-metrics-webapp Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 396 KB

This React capstone project for Microverse is a mobile web application that allows users to check a list of metrics (numeric values) retrieved from a selected API. The API that was selected is called REST countries, where you can get information about countries via a RESTful API.

Home Page: https://benevolent-crostata-5c4bea.netlify.app/

License: MIT License

HTML 2.44% CSS 20.13% JavaScript 77.44%
api css3 documentation javascript metrics microverse-projects react reactjs rest rest-api

capstone-metrics-webapp's Introduction

Capstone Metrics Webapp

πŸ“— Table of Contents

πŸ“– Mini World Atlas

Mini World Atlas is a React mobile web application that allows users to check a list of metrics (numeric values) retrieved from a selected API called REST countries, where you can get information about countries via a RESTful API.

REST Countries API is a RESTful API that provides information about 200+ countries and territories. It is a free and open-source API, and it does not require an API key. The API is based on the JSON (JavaScript Object Notation) format, and it provides information about a country's name, flag, coat of arms, capital, population, area, borders, currencies, languages, and more.

This project was created as part of the Microverse Full-Stack Web Development Program, which is a 12-month program that teaches students the skills they need to become full-stack web developers. The program includes training on a variety of programming tools, such as React, JSX, CSS, and JavaScript.

The webapp has been deployed to Netlify and is now available for you to try. Click the link below to visit the live demo.

πŸ›  Built With

  • React / Redux
  • JSX
  • CSS
  • Javascript ES6
  • Visual Studio Code
  • Jest
  • React Testing Library
  • ESLint
  • Stylelint
  • Webpack
  • Babel
  • External API (REST Countries)

Key Features

The key features of this project include the following.

  • Fetchs and displays data from API, which lists almost 200 countries and territories.
  • Displays the estimated population of the world on the homepage, also directly from the API.
  • Displays the country detail with their Area, Population, Coat of Arms, Flag, Capital City, Continent, Time Zone, and a 3-letter Country Code.
  • Uses a mobile web responsive layout format that looks good and are easy to use on mobile devices.

(back to top)

πŸš€ Live Demo

Due to the fact that it is a web app that is not optimized for desktop use, the live demo link is best viewed in mobile mode.

To change the resolution into mobile, you can use the Inspect method which is available in Google Chrome or Microsoft Edge. Here are the following steps:

  • Open the live link of the website (listed above).
  • Right click and select "Inspect" from the dropdown menu.
  • In the Inspect section, select the mobile device you want to simulate from the list.
  • You can also change the dimension to 830 x 630 by customizing it on the Responsive section.
  • The website will now be displayed in the mobile view of the browser.

(back to top)

πŸ’» Getting Started

Get ready to explore Mini World Atlas Webapp with these steps:

Prerequisites

Ensure you have:

  • A Web Browser such as Microsoft Edge or Google Chrome 🌐
  • Git πŸ™
  • A code editor such as Visual Studio Code πŸ‘¨β€πŸ’»

Setup

Use git clone to get your local copy of the project.

git clone https://github.com/katarighe/capstone-metrics-webapp.git

Install

Run npm install to set up the required packages.

npm install

Run Tests

To run tests run the following command in your terminal

 npm test

Currently, there are no test scripts available, but the libraries (React Testing Library and Jest) are set up.

You can also check linter errors by running this commands:

npx stylelint "**/*.{css,scss}"
npx eslint "**/*.{js,jsx}"

Usage

Launch the app with the following command

  npm start

(back to top)

πŸ‘₯ Authors

πŸ‘€ Mohamed Aden Ighe

(back to top)

πŸ”­ Future Features

Here are some future features that could be added to the Mini World Atlas Webapp in the future.

  • Interactive maps: The maps in the Mini World Atlas Webapp will be made more interactive, allowing users to zoom in and out, pan around, and explore different countries in more detail.

  • More detailed country profiles: The country profiles in the Mini World Atlas Webapp will be expanded to include more information about each country, such as its history, culture, economy, and government.

  • New languages: The Mini World Atlas Webapp will be translated into more languages, making it accessible to a wider audience.

  • More data sources: The Mini World Atlas Webapp will be powered by more data sources, providing users with the most up-to-date information about countries.

  • Collaboration tools: The Mini World Atlas Webapp will be made more collaborative, allowing users to share information and collaborate on projects.

Moreover, here are some other possible features that could be added in the future:

  • A search bar to make it easier to find information about specific countries.

  • The ability to add notes and comments to country profiles.

  • The ability to create custom maps.

  • The ability to export data from the Mini World Atlas Webapp.

The following are a few ideas for future features that could be added to the Mini World Atlas Webapp. The specific features that are added will depend on the feedback and suggestions of users.

(back to top)

🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a star⭐️ or a thumbs up πŸ‘ if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

πŸ™ Acknowledgments

(back to top)

πŸ“ License

This project is MIT licensed.

(back to top)

capstone-metrics-webapp's People

Contributors

katarighe avatar

Stargazers

Joyce Cruz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.