The Metrics Webapp

📗 Table of Contents

• The Metrics Webapp
• 📖 The Metrics Webapp
  • 🛠 Built With React
    • React Instructions
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • To add dependencies and run linter tests
    • Deployment
  • 👥 Author
    • Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 The Metrics Webapp

The "Metrics Webapp" is a simple yet powerful, React and Redux capstone, single page mobile web application build around a list of metrics (numeric values) fetched from an external API with several pages.

The home page consists of a filterable list of items in which each item navigates to the item's details info grid.

Home page

• When the page loads, the webapp shows the list of categories that could be filtered out by some parameter, for example by the category name.
• Along with the category name, displays numeric values per category that come from the API.
• When the user clicks (or taps) on a category item, the application navigates to the details page.

Details page

• 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.

Home Page

🛠 Built With React

React Instructions

This project was bootstrapped with Create React App. -Available Scripts In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Tech Stack

Client

- React

• Components
• Hooks
• Props
• Events
• Router
• Redux
• Fetch data from API
• Unit Test
• Integration Test
• Deploy

Server

• The project can be deployed and accessible online using [Render](https://render.com), [Netlify](https://www.netlify.com/) or [GitHub Pages](https://pages.github.com/).

Database

• N/A

Key Features

• Use of React Components
• Use of Events
• Use of React Router
• Use of API to fetch data
• Use of JEST & RTL for unit and integration test
• Use of React Redux (e.g store, reducers, actions)

(back to top)

🚀 Live Demo

Please follow the link for a live demo.

• The matrices webapp: Coming Soon...

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

• Git.
• An IDE (e.g. VS Code)
• Browser to run.

Setup

Clone this repository to your desired folder:

• Using Git Bash or any integrated terminal of you choice.
• Open with code editor (e.g. VS Code).
• Open the index.html file using any local server (e.g. live server extension in VS Code)

Usage

To run the project, execute the following command:

• Open the index.html file on a local server on your browser.

To add dependencies and run linter tests

Follow the following:

---

Initial Step:

---

• mkdir .github/workflows
• copy the linters.yml file to the directory created above.
• touch .gitignore if not created already and add node_modules/ to it.
• initialize npm to create package.json file by running the command:

$ npm i -y

---

ESLint

---

1. Run

   npm install --save-dev [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] @babel/[email protected] @babel/[email protected]  @babel/[email protected]  @babel/[email protected] @babel/[email protected]
   

2. Copy .eslintrc.json and .babelrc to the root directory of your project.
3. Run npx eslint "**/*.{js,jsx}" on the root of your directory of your project.
4. Fix linter errors. For more on ESLint & autocorrent options, click here

---

For Stylelint

---

1. Run

   npm install --save-dev [email protected] [email protected] [email protected] [email protected]
   

2. Copy .stylelintrc.json to the root directory of your project.
3. Run npx stylelint "**/*.{css,scss}" on the root of your directory of your project.
4. Fix linter errors. For more on Stylelint & autocorrent options, click here

(back to top)

👥 Author

Developed by:

Authors

• GitHub: @porag-m06
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Improve Aesthetics & Design

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

As a tech enthusiast, your support is always appreciated. If you like this project please do let me know with your support in any way you see fit.

(back to top)

🙏 Acknowledgments

Original design idea by Nelson Sakwa on Behance. Additionally, I would like to thank Microverse for this project info & guidelines.

(back to top)

❓ FAQ

• Can I fork this project?

  • Yes, feel free to fork and knock yourself out :) .

• Can I share this project with others?

  • Yes, you can share this project for any educational purposes.

(back to top)

📝 License

This project is MIT licensed.

(back to top)