https://github.com/indiecodermm/gh-dashboard
📊 Website that allows users to generate a stylish GitHub Dashboard just by entering username. Built with React, Redux & GitHub API
https://github.com/indiecodermm/gh-dashboard
github-api github-dashboard reactjs redux styled-components
Last synced: 3 months ago
JSON representation
📊 Website that allows users to generate a stylish GitHub Dashboard just by entering username. Built with React, Redux & GitHub API
- Host: GitHub
- URL: https://github.com/indiecodermm/gh-dashboard
- Owner: IndieCoderMM
- License: mit
- Created: 2023-01-30T15:01:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-12T11:36:14.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T05:53:51.144Z (3 months ago)
- Topics: github-api, github-dashboard, reactjs, redux, styled-components
- Language: JavaScript
- Homepage: https://gh-dashboard-icmm.onrender.com
- Size: 1.01 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 📑 Table of Contents
- [📊 GitHub Dashboard Generator ](#-github-dashboard-generator-)
- [🛠 Built With ](#-built-with-)
- [🧰 Tech Stack ](#-tech-stack-)
- [💎 Key Features ](#-key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [� Getting Started ](#-getting-started-)
- [📋 Prerequisites](#-prerequisites)
- [📂 Setup](#-setup)
- [📥 Installation](#-installation)
- [🔑 Token](#-token)
- [💻 Usage](#-usage)
- [🎈 Deployment](#-deployment)
- [📧 Contact ](#-contact-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [💖 Show your support ](#-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
# 📊 GitHub Dashboard Generator
A web-based application that creates a dashboard for a user by using data from the GitHub API. Simply enter a GitHub username and the app will generate a dashboard displaying overview of relevant information. Users can also copy the link to their dashboard for easy access.
- 
- 
- 
- 
- 
- Generate a comprehensive dashboard using data from GitHub API 💻
- Overview of repositories, followers, stars and more 📈
- Beautifully designed and easy-to-use 🎨
- Instant snapshot of your GitHub presence 📸
- Save your dashboard link for easy access 🔗
You can visit the website on [GitHub Dashboard Generator](https://gh-dashboard-icmm.onrender.com/).
To run this project locally, follow these steps.
### 📋 Prerequisites
Before you begin, ensure that you have [Node.js](https://nodejs.org/en/) installed on your machine.
### 📂 Setup
Clone this repository to your desired folder:
```sh
cd my-project
git clone [email protected]:IndieCoderMM/gh-dashboard.git .
```
### 📥 Installation
Install the dependencies with:
```sh
npm install
```
### 🔑 Token
You need a personal access token from Github to run this project locally.
1. Generate a new token in [GitHub Setting](https://github.com/settings/tokens).
2. Create a `.env` file in project root directory.
3. Add your generated token to the `.env` file.
```sh
REACT_APP_GITHUB_ACCESS_TOKEN = your_github_token
```
4. Restart your server after adding this variable.
### 💻 Usage
To run the project, execute the following command:
```sh
npm start
```
### 🎈 Deployment
You can deploy this project using:
```sh
npm run build
```
This will create a production-ready build of your website in `build/` folder, which you can use to deploy to a hosting service.
I am always looking for ways to improve my project. If you have any suggestions or ideas, I would love to hear from you.
[](https://github.com/IndieCoderMM)
[](https://twitter.com/hthant_oo)
[](https://linkedin.com/in/hthantoo)
[](mailto:[email protected])
- [x] **Mobile UI**
- [ ] **Visualize contribution**
I welcome any and all contributions to my website! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.
Feel free to check the [issues page](../../issues/).
If you like this project, please consider giving it a ⭐.
This project was inspired by:
- [GitHub Finder](https://github.com/JasurbekIsokov/github-finder)
- [GitHub Profile Finder](https://devpost.com/software/github-profile-finder)
This project is [MIT](./LICENSE) licensed.