Welcome to the Github Wrapped API documentation. This API is built using the Go programming language with the Fiber framework, leveraging GORM as the ORM for database connections. PostgreSQL is used as the main database, ensuring high performance and scalability. It connects directly to GitHub's platform using the user's Personal Access Token (PAT), providing detailed insights into user activity across both public and private repositories. The API ensures high performance, security, and transparency, without storing sensitive user data.
Below are the features of the API:
- Comprehensive Follower & Unfollower Insights: Retrieve the total number of followers and unfollowers along with their detailed lists to analyze user engagement effectively.
- Detailed Following & Unfollowing Information: Access the total number of followings and unfollowings, complete with a detailed list for in-depth tracking.
- Repository Analysis: Fetch the total number of repositories owned by the user along with a comprehensive list and retrieve the total commits for each repository within a specified date range for targeted analysis.
- Forked Repository Insights: Analyze the total number of repositories forked by the user along with their detailed lists and examine the total commits made to each forked repository within a specific date range.
- Contribution to External Repositories: Discover repositories where the user has contributed but does not own and view the total commits for each contributed repository within a specified date range.
- Starred Repository Metrics: Fetch the total stars the user has given to repositories, along with a detailed list and filter the results by date range for more focused insights.
- Received Star Insights: Retrieve the total stars received by the user’s repositories and identify which repositories received stars and who gave it within a specified date range.
- Favorite Languages Analysis: Determine the user’s favorite programming languages based on the total bytes of code written in owned repositories.
- No Token Storage: Tokens are used in memory during the session and are not stored in the application.
- User Control: Users can verify the source code, clone the repository, and run the application locally to ensure transparency.
- Token Removal: Tokens can be removed from GitHub after use for additional peace of mind.