Git Product home page Git Product logo

giha's Introduction

GIHA (Github Insights and Heuristic Analysis)

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.

Table of Contents

Introduction

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.

Features

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.

Installation

To install and run GIHA locally, please follow these steps:

  1. Clone the repository:

    git clone https://github.com/zemetskiym/giha.git
  2. Navigate to the project directory:

    cd giha
  3. Ensure you have Node.js installed. If not, download and install it.

  4. Install dependencies:

    npm install
  5. Start the development server:

    npm run dev
  6. Access the website in your browser at http://localhost:3000.

Usage

  1. Visit the GIHA website at http://localhost:3000 or the deployed URL.
  2. Authenticate with your GitHub account using OAuth to increase your rate limit and access private repositories.
  3. Enter the GitHub username you wish to analyze.
  4. Explore the various charts and sections to gain insights into the user's programming languages and commit patterns.
  5. Download charts as SVG files for easy sharing and presentation.

Technologies Used

GIHA is built using the following technologies and frameworks:

  • Next.js
  • D3.js
  • highlight.js
  • NextAuth.js

License

GIHA is licensed under the MIT License. See the LICENSE file for details.

Contributing

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.

Acknowledgements

We would like to acknowledge the following resources and libraries that made GIHA possible:

Contact

For any inquiries or feedback, please contact us at [email protected].

giha's People

Contributors

zemetskiym avatar

Stargazers

Athena Petrovich avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.