GIHA is a web-based tool for analyzing GitHub profiles, providing valuable insights into programming languages, commit distribution, and fun facts about users' coding habits. This README provides an overview of the project, its features, and instructions for installation and usage.
- Introduction
- Features
- Installation
- Usage
- Technologies Used
- License
- Contributing
- Acknowledgements
- Contact
GIHA is an acronym for "GitHub Insights and Heuristic Analysis," emphasizing its focus on providing genuine and insightful information about GitHub users' profiles. The website utilizes Next.js, D3.js, highlight.js, and NextAuth.js to create an interactive and visually appealing interface for data analysis.
GIHA offers the following key features:
- Stacked Area Chart: Visualize a user's programming language usage over time.
- Pie Chart: Quickly glance at the overall distribution of programming languages used.
- Barcode Plot: Explore the distribution of a user's commits over time and across various repositories.
- Fun Facts Section: Discover interesting statistics and patterns about a user's coding habits, including average lines of code per commit, common programming conventions, most active day of the week, and most active time of day.
- Line Chart: Display the most active day of the week with inline labels.
- Bar Chart: Analyze the distribution of commits over lines of code (LOC).
- SVG Download: Easily share charts by downloading them as SVG files.
- OAuth Authentication: Authenticate with OAuth to increase your rate limit and view private work.
To install and run GIHA locally, please follow these steps:
-
Clone the repository:
git clone https://github.com/zemetskiym/giha.git
-
Navigate to the project directory:
cd giha
-
Ensure you have Node.js installed. If not, download and install it.
-
Install dependencies:
npm install
-
Start the development server:
npm run dev
-
Access the website in your browser at
http://localhost:3000
.
- Visit the GIHA website at
http://localhost:3000
or the deployed URL. - Authenticate with your GitHub account using OAuth to increase your rate limit and access private repositories.
- Enter the GitHub username you wish to analyze.
- Explore the various charts and sections to gain insights into the user's programming languages and commit patterns.
- Download charts as SVG files for easy sharing and presentation.
GIHA is built using the following technologies and frameworks:
- Next.js
- D3.js
- highlight.js
- NextAuth.js
GIHA is licensed under the MIT License. See the LICENSE file for details.
We welcome contributions to GIHA! If you find any issues or have ideas for improvements, please submit them as GitHub Issues. Pull requests are also appreciated.
Before contributing, please review our Contributing Guidelines.
We would like to acknowledge the following resources and libraries that made GIHA possible:
- Next.js: https://nextjs.org
- D3.js: https://d3js.org
- highlight.js: https://highlightjs.org
- NextAuth.js: https://next-auth.js.org
For any inquiries or feedback, please contact us at [email protected]
.