Using the API to get data about users or their repositories to use in production website

[GrecuAlexandru]

Select Topic Area

Question

Body

Hello! I am making an website where users can create their own profile. Among other things, I want to let them connect/link their github account so other people can see stats like: number of commits this month, each repo he has, what languages are used inside a repo, readme files for each repo, etc. I noticed you can get stats about your personal projects using a personal token, is this the only way? I only want to get the stats only from public repositories.

Can this be done for a website that is going to be public and maybe monetized?
If so, how?

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬

[SjxSubham]

Yes, you can achieve this by using GitHub's public APIs to fetch the required data from public repositories without the need for a personal token. Here's a brief overview of how you can implement this:

-[x] GitHub OAuth App:

• Create a GitHub OAuth App to allow users to authenticate with their GitHub account.

• Get an access token for the authenticated user.

• Fetching Data:

  • Use the GitHub REST API to fetch data such as commits, repositories, languages, and README files.
  • For public repositories, you generally don't need a personal access token, but authenticated requests (even with OAuth tokens) can help you avoid rate limits.

• Endpoints to Use:

  • List repositories: GET /users/{username}/repos
  • List commits: GET /repos/{owner}/{repo}/commits
  • Get languages: GET /repos/{owner}/{repo}/languages
  • Get README: GET /repos/{owner}/{repo}/readme

• Handling Rate Limits:

  • Ensure you handle rate limits by checking the headers in API responses and implementing retry logic if necessary.

• Monetization:

  • Ensure compliance with GitHub's Terms of Service, especially around monetization and API usage.

To get started, create a GitHub OAuth App and then use the GitHub API to fetch the necessary data for your website.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬