|
| 1 | +# GitGlance |
| 2 | +A tool for visualizing GitHub profiles. |
| 3 | +Visit our website [GitGlance](https://gitglance.vercel.app/) |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | +- [About Us](#about-us) |
| 7 | +- [Tech stack](#tech-stack) |
| 8 | +- [Features](#features) |
| 9 | +- [GitGlance Application](#gitglance-application) |
| 10 | +- [Setting up the project](#setting-up-the-project) |
| 11 | +- [Contributing](#contributing) |
| 12 | +- [How to Contribute](#how-to-contribute) |
| 13 | +- [Code of Conduct](#code-of-conduct) |
| 14 | + |
| 15 | +## About Us |
| 16 | +GitGlance is a powerful tool for visualizing a developer's GitHub profile, showcasing their contributions, fields of expertise, and much more. With GitGlance, developers can gain insights into their GitHub activity in an intuitive and visually appealing manner. |
| 17 | + |
| 18 | +## Tech stack |
| 19 | +GitGlance utilizes the following technologies and libraries: |
| 20 | + |
| 21 | +- [Next.js](https://nextjs.org/) |
| 22 | +- [Tailwind CSS](https://tailwindcss.com/) |
| 23 | +- [GitHub GraphQL API](https://docs.github.com/en/graphql) |
| 24 | +- [Node.js](https://nodejs.org/) |
| 25 | + |
| 26 | +## Features |
| 27 | +- **GitHub Profile Visualization**: GitGlance provides a comprehensive visualization of a developer's GitHub profile, including their contributions, repositories, and more. |
| 28 | +- **Field of Contributions**: Understand the areas in which the developer contributes the most through a graphical representation. |
| 29 | +- **GitHub GraphQL API Integration**: Utilizing the GitHub GraphQL API, GitGlance fetches user data directly from GitHub, ensuring accurate and up-to-date information. |
| 30 | +- **Next.js & Tailwind CSS**: Built with Next.js for efficient server-side rendering and Tailwind CSS for easy styling and customization. |
| 31 | +- **Responsive Design**: GitGlance is designed to be responsive, ensuring a seamless experience across various devices and screen sizes. |
| 32 | +- **Dynamic Chart Generation**: GitGlance employs advanced chart generation techniques to dynamically visualize GitHub data. Whether it's plotting commit timelines, repository language distributions, or pull request statistics, GitGlance generates interactive and customizable charts. |
| 33 | + |
| 34 | +## GitGlance Application |
| 35 | +<img src="./public/screenshots/2.png" width="75%" /> |
| 36 | +<img src="./public/screenshots/3.png" width="75%" /> |
| 37 | +<img src="./public/screenshots/4.png" width="75%" /> |
| 38 | +<img src="./public/screenshots/5.png" width="75%" /> |
| 39 | +<img src="./public/screenshots/6.png" width="75%" /> |
| 40 | + |
| 41 | + |
| 42 | +## Setting up the project |
| 43 | +To run GitGlance locally, follow these steps: |
| 44 | + |
| 45 | +1. Clone the repository: |
| 46 | + ```bash |
| 47 | + git clone https://github.com/your-username/gitglance.git |
| 48 | + ``` |
| 49 | + |
| 50 | +2. Navigate to the project directory: |
| 51 | + ```bash |
| 52 | + cd gitglance |
| 53 | + ``` |
| 54 | +3. Create a .env file in the root directory of the project by copying the .env.example file: |
| 55 | + ```bash |
| 56 | + cp .env.example .env |
| 57 | + ``` |
| 58 | +4. Open the .env file and add your GitHub Personal Access Token: |
| 59 | + ```bash |
| 60 | + GITHUB_TOKEN= |
| 61 | + ``` |
| 62 | +5. Install dependencies: |
| 63 | + ```bash |
| 64 | + npm install |
| 65 | + ``` |
| 66 | +6. Start the development server: |
| 67 | + ```bash |
| 68 | + npm run dev |
| 69 | + ``` |
| 70 | +7. Open your browser and visit `http://localhost:3000` |
| 71 | + |
| 72 | + |
| 73 | +## Contributing |
| 74 | +Contributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request. |
| 75 | + |
| 76 | + |
| 77 | +## How to Contribute |
| 78 | +We welcome contributions from the community to enhance GitGlance further.You can use GitHub Desktop to manage this repository. Here's how: |
| 79 | +
|
| 80 | +1. **Download and Install GitHub Desktop**: |
| 81 | + - Go to the [GitHub Desktop website](https://desktop.github.com/) and download the GitHub Desktop application. |
| 82 | + - Follow the installation instructions to install GitHub Desktop on your computer. |
| 83 | +
|
| 84 | +2. **Clone the Repository**: |
| 85 | + - Open GitHub Desktop and sign in to your GitHub account. |
| 86 | + - Click on the "File" menu, then select "Clone Repository..." |
| 87 | + - Choose the repository you want to clone from the list or enter its URL. |
| 88 | + - Choose the local path where you want to clone the repository and click "Clone". |
| 89 | +
|
| 90 | +3. **Make Changes**: |
| 91 | + - After cloning the repository, you can make changes to the files locally using your preferred code editor. |
| 92 | +
|
| 93 | +4. **Commit Changes**: |
| 94 | + - Once you've made changes, open GitHub Desktop. |
| 95 | + - You'll see a list of files with changes. Write a summary and description of your changes in the text fields. |
| 96 | + - Click "Commit to main" to commit your changes locally. |
| 97 | +
|
| 98 | +5. **Push Changes**: |
| 99 | + - To push your changes to the remote repository on GitHub.com, click "Push origin". |
| 100 | +
|
| 101 | +6. **Pull Changes**: |
| 102 | + - If there are changes on the remote repository that you don't have locally, you can pull them by clicking "Fetch origin" or "Pull origin". |
| 103 | + |
| 104 | +7. **Sync Changes**: |
| 105 | + - To synchronize your local repository with the remote repository, click "Sync" to push and pull changes in one step. |
| 106 | + |
| 107 | +That's it! You can now use GitHub Desktop to manage this repository efficiently. |
| 108 | +
|
| 109 | +
|
| 110 | +## Code of Conduct |
| 111 | +For all the enthusiastic contributers, please refer to the [Code of Conduct](https://github.com/devXprite/gitglance/blob/main/CODE_OF_CONDUCT.md) |
0 commit comments