README.md

📑 Table of Contents

• 📊 GitHub Dashboard Generator
  • 🛠 Built With
    • 🧰 Tech Stack
    • 💎 Key Features
  • 🚀 Live Demo
  • � Getting Started
    • 📋 Prerequisites
    • 📂 Setup
    • 📥 Installation
    • 🔑 Token
    • 💻 Usage
    • 🎈 Deployment
  • 📧 Contact
  • 🔭 Future Features
  • 🤝 Contributing
  • 💖 Show your support
  • 🙏 Acknowledgments
  • 📝 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.

🛠 Built With

🧰 Tech Stack

• 
• 
• 
• 
• 

💎 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 [email protected]: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

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

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

• GitHub Finder
• GitHub Profile Finder

(back to top)

📝 License

This project is MIT licensed.

(back to top)