mohamedSabry0 / gh-metrics

GitHub Metrics is a user-friendly metrics moblie application developed with React.js, designed specifically to analyze and track metrics for forks of a popular repository on GitHub.

GitHub Metrics App

📗 Table of Contents

• 📗 Table of Contents
• 📖 GitHub Metrics
  • Screenshot
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
      • npm start
    • Run tests
      • npm test
  • 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🔭 Future Features
  • Acknowledgements
  • 📝 License

📖 GitHub Metrics

GitHub Metrics is a simple metrics app built with React.js

Due to the time constraint, and github API limitations, only metrics about forks of a popular repository will be displayed.

Screenshot

🛠 Built With

Tech Stack

Client

• React.js

Key Features

• [Single Page Application]
• [Reusable Components]

(back to top)

🚀 Live Demo

• Live Demo Link
• Video Demo Link

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

• Node
• npm

Probably with versions:

• Node >= 19.6.0
• npm >= 9.4.0

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [e-mail]:mohamedSabry0/gh-metrics.git

Install

Install this project with:

  cd gh-metrics
  npm i

Usage

To run the project, execute the following command:

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.

Run tests

To run tests, run the following command:

npm test

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

(back to top)

👥 Authors

👤 Mohamed Sabry

• GitHub: @mohamedSabry0
• Twitter: @mohsmh0
• LinkedIn: LinkedIn

(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 it would be truly appreciated if you give it a ⭐️.

(back to top)

🔭 Future Features

• [Improve Styling]
• [Add Search by name]

(back to top)

Acknowledgements

We seek knowledge from the cradle to the grave.

I am grateful for these resources as they were a reason that I obtained a glimpse of their abundance of knowledge:

• Microverse
• This is inspired by this design by Nelson Sakwa
• ReactJS Docs
• React Router Docs
• Redux toolkit usage guide
• @gitdagray react_redux_toolkit tutorial
• https://codepen.io/ilPas/pen/jYeEyV
• I also thank other resources that might have slipped from my mind to mention, I really appreciate all the efforts in delivering helpful resources of knowledge.

(back to top)

📝 License

This project is MIT licensed.

(back to top)