This project focuses on building a user-friendly tool that automates the creation of visually appealing and customizable GitHub organizational profiles, rendered entirely in SVG (Scalable Vector Graphics) format.
- Learn how to use Octokit.js to interact with the GitHub REST API in your JavaScript scripts.
- Learn how to build a tool using GitHub Actions.
- Learn how to contribute to open source software.
- Receive mentorship throughout the challenge.
- Javascript/Typescript
- CI/CD (Github Actions)
- Github SDK
This tool empowers GitHub organizations to streamline the creation of their profiles.
Export the following information as SVG to embed in the README file for data visualization.
-
Base content, the following sections are supported:
header: which usually contains organization name and a few additional data.community: which contains community stats (following, sponsors, etc.).repositories: which contains repository stats (license, forks, stars, etc.).
These are all enabled by default, but it is possible to explicitly opt out from them.
-
Programming languages used by organization members.
-
Stargazers evolution across affiliated repositories (total stargazers, new stargazers per day).
-
Coding habits based on recent activity, such as active hours and languages recently used.
-
Ratio of open/closed issues and the ratio of open/merged pull requests across repositories.
-
Recent activity on GitHub. Events types are fetched from GitHub events API and the following types are currently supported:
push: Push of commits.issue: Opening/Reopening/Closing of issues.pr: Opening/Closing of pull requests.release: Publication of new releases.review: Review of pull requests.comment: Comments on commits, issues and pull requests.fork: Forking of repositories.star: Starring of repositories.public: Repositories made public.member: Addition of new collaborator in repository.
-
Github projects.
- An infographics generator to display stats about your GitHub account: https://github.com/lowlighter/metrics.
- A tool to generate your github summary card for profile README: https://github.com/vn7n24fzkq/github-profile-summary-cards.