Skip to content

πŸ“Š Website that allows users to generate a stylish GitHub Dashboard just by entering username. Built with React, Redux & GitHub API

License

Notifications You must be signed in to change notification settings

IndieCoderMM/gh-dashboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

31 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“‘ Table of Contents

πŸ“Š 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.

Screenshot

πŸ›  Built With

🧰 Tech Stack

  • React
  • Redux
  • React Router
  • Styled Components
  • Render

πŸ’Ž Key Features

  • 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 πŸ”—

(back to top)

πŸš€ Live Demo

You can visit the website on GitHub Dashboard Generator.

(back to top)

πŸ“— Getting Started

To run this project locally, follow these steps.

πŸ“‹ Prerequisites

Before you begin, ensure that you have Node.js installed on your machine.

πŸ“‚ Setup

Clone this repository to your desired folder:

  cd my-project
  git clone git@github.com:IndieCoderMM/gh-dashboard.git .

πŸ“₯ Installation

Install the dependencies with:

  npm install

πŸ”‘ Token

You need a personal access token from Github to run this project locally.

  1. Generate a new token in GitHub Setting.
  2. Create a .env file in project root directory.
  3. Add your generated token to the .env file.
REACT_APP_GITHUB_ACCESS_TOKEN = your_github_token
  1. Restart your server after adding this variable.

πŸ’» Usage

To run the project, execute the following command:

  npm start

🎈 Deployment

You can deploy this project using:

  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.

(back to top)

πŸ“§ Contact

I am always looking for ways to improve my project. If you have any suggestions or ideas, I would love to hear from you.

Github Twitter Linkedin Gmail

(back to top)

πŸ”­ Future Features

  • Mobile UI
  • Visualize contribution

(back to top)

🀝 Contributing

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.

(back to top)

πŸ’– Show your support

If you like this project, please consider giving it a ⭐.

(back to top)

πŸ™ Acknowledgments

This project was inspired by:

(back to top)

πŸ“ License

This project is MIT licensed.

(back to top)

About

πŸ“Š Website that allows users to generate a stylish GitHub Dashboard just by entering username. Built with React, Redux & GitHub API

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published