Skip to content

Github_Info.md

Latest commit

 

History

History
288 lines (266 loc) · 11.9 KB

Github_Info.md

File metadata and controls

288 lines (266 loc) · 11.9 KB

Github Development Statistics

GitHub is a web-based platform that provides a powerful set of tools for software developers to collaborate on projects. It is primarily used for version control, which means that it helps developers keep track of changes made to code over time. With GitHub, developers can easily contribute to open-source projects, create and manage repositories - public or private depending on the developer's preference, and collaborate with other developers around the world.

Quick implementations

Here are basic Markdown implementations of the github routes image rendering

    [Github Profile Stats](https://greenj-readme-stats.onrender.com/github/stats/<username>)

    [Github Profile Trophies](https://greenj-readme-stats.onrender.com/github/trophies/<username>)

    [Github Profile Languages](https://greenj-readme-stats.onrender.com/github/languages/<username>)

    [Github Profile Streak](https://greenj-readme-stats.onrender.com/github/streak/<username>)

Advanced Image Implimentations:

<picture>
    <source
        srcset="<api route, light themed>"
        media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
    />
    <source
        srcset="<api route, dark themed>"
        media="(prefers-color-scheme: dark)"
    />
    <img
        src="<base api route>"
        alt="Github Profile"
    />
</picture>




Route Details



⚡ Github Profile Stats ⚡

GreenJ84's Github Profile Stats



https://greenj-readme-stats.onrender.com/github/stats/<username>
- This route provides the all the commits, pull requests, issues, and repositories created by the user. Plus, it shows the total stars earned and total projects contributed to. The stats are also compiled to provide an overall grade to the statistics provided.

All current parameters for this route are following:

  • Global API Parameters and descriptions are here
  • title:
     - This optional parameter allows for User's to provide a custom title to the SVG. Please provide the title in Snake_case with your prefered capitilzations. (Ex. GreenJ84's_WakaTime_Insights -> GreenJ84's WakaTime Insights)

    •    *** Please provide the color value for the following parameters as either a valid color name or HEX code. ***

  • textMain:
     - This optional parameter allows for the User to provide a color for the main title of the modal.
  • ring:
     - This optional parameter allows for the User to provide a color for the ring detail wrapping the overall letter grade score provided.
  • score:
     - This optional parameter allows for the User to provide a color for the value of the overall letter grade score provided.
  • textSub:
     - This optional parameter allows for the User to provide a color for all of the titles of each statistics catergory.
  • icons:
     - This optional parameter allows for the User to provide a color for all the statistics category icons.
  • stats:
     - This optional parameter allows for the User to provide a color for all of the values of each statistics catergory.




⚡ Github Profile Languages ⚡

GreenJ84's Github Profile Languages



https://greenj-readme-stats.onrender.com/github/languages/<username>
- This route provides the user's top 8 most used languages within all of their owned github repositories.

All current parameters for this route are following:

  • Global API Parameters and descriptions are here
  • title:
     - This optional parameter allows for User's to provide a custom title to the SVG. Please provide the title in Snake_case with your prefered capitilzations. (Ex. GreenJ84's_WakaTime_Insights -> GreenJ84's WakaTime Insights)

    •    *** All Development language markers and pie section colors are based off of GitHub's language color pairings ***
       *** Please provide the color value for the following parameters as either a valid color name or HEX code. ***

  • textMain:
     - This optional parameter allows for the User to provide a color for the main title of the modal.
  • textSub:
     - This optional parameter allows for the User to provide a color for the title of each development language.
  • stats:
     - This optional parameter allows for the User to provide a color for the percentage statistic of each development language.




⚡ Github Profile Streak ⚡

GreenJ84's Github Profile Streak



https://greenj-readme-stats.onrender.com/github/streak/<username>
- This route provides details for the user's current github commit streak, the longest recorded github commit streak, and the total number of contributions since account creation.

All current parameters for this route are following:

  • Global API Parameters and descriptions are here
  • title:
     - This optional parameter allows for User's to provide a custom title to the SVG. Please provide the title in Snake_case with your prefered capitilzations. (Ex. GreenJ84's_WakaTime_Insights -> GreenJ84's WakaTime Insights)

    •    *** Please provide the color value for the following parameters as either a valid color name or HEX code. ***

  • textMain:
     - This optional parameter allows for the User to provide a color for the main title of the modal and the title of the modal's main current development streak statistic.
  • ring
     - This optional parameter allows for the User to provide a color for the ring detail wrapping the main current development streak statistic.
  • fire
     - This optional parameter allows for the User to provide a color for the fire detail that rests above the main current development streak statistic.
  • currStreak
     - This optional parameter allows for the User to provide a color for the value of modal's main statistic title, current development streak.
  • sideStat
     - This optional parameter allows for the User to provide a color for the title of the two side statistics, total development time and best development day statisctics.
  • textSub
     - This optional parameter allows for the User to provide a color for the title of the two side statistics, total commit contributions and longest commit streak statisctics.
  • dates
     - This optional parameter allows for the User to provide a color for the sub-title of all the development statistics (the dates provided).

Usage

This API is meant to be a simple development statistics display for User's looking to attatch to personal profiles