https://github.com/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.
https://github.com/mohamedsabry0/gh-metrics
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/mohamedsabry0/gh-metrics
- Owner: mohamedSabry0
- Created: 2023-05-27T18:42:01.000Z (about 2 years ago)
- Default Branch: development
- Last Pushed: 2023-06-05T14:03:54.000Z (about 2 years ago)
- Last Synced: 2025-02-07T21:43:49.661Z (4 months ago)
- Language: JavaScript
- Homepage: https://gh-metrics.onrender.com/
- Size: 1.29 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
GitHub Metrics App
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 GitHub Metrics ](#-github-metrics-)
- [Screenshot ](#screenshot-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [`npm start`](#npm-start)
- [Run tests](#run-tests)
- [`npm test`](#npm-test)
- [👥 Authors ](#-authors-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🔭 Future Features ](#-future-features-)
- [Acknowledgements ](#acknowledgements-)
- [📝 License ](#-license-)
**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.
Client
- **[Single Page Application]**
- **[Reusable Components]**
- [Live Demo Link](https://gh-metrics.onrender.com)
- [Video Demo Link](https://www.loom.com/share/9bf2232a894a465db885a1f4ded155c8)
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:
```sh
cd my-folder
git clone [email protected]:mohamedSabry0/gh-metrics.git
```
### Install
Install this project with:
```sh
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](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](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
👤 **Mohamed Sabry**
- GitHub: [@mohamedSabry0](https://github.com/mohamedSabry0)
- Twitter: [@mohsmh0](https://twitter.com/mohsmh0)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mohamed-sabry0/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/mohamedSabry0/gh-metrics/issues).
If you like this project it would be truly appreciated if you give it a ⭐️.
- [ ] **[Improve Styling]**
- [ ] **[Add Search by name]**
> 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](https://www.microverse.org/)
- This is inspired by this [design]() by [Nelson Sakwa](https://www.behance.net/sakwadesignstudio)
- [ReactJS Docs](https://reactjs.org/docs)
- [React Router Docs](https://reactrouter.com/en/main)
- [Redux toolkit usage guide](https://redux-toolkit.js.org/usage/usage-guide)
- @gitdagray [react_redux_toolkit tutorial](https://www.youtube.com/watch?v=93CR_yURoII)
- 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.
This project is [MIT](./MIT.md) licensed.