https://github.com/fredvuni/react-github-profile-generator
A react JS application that fetches user data using the Github API
https://github.com/fredvuni/react-github-profile-generator
contextapi github javascript react
Last synced: 9 months ago
JSON representation
A react JS application that fetches user data using the Github API
- Host: GitHub
- URL: https://github.com/fredvuni/react-github-profile-generator
- Owner: FREDVUNI
- Created: 2022-05-10T06:38:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-05T08:14:22.000Z (about 1 year ago)
- Last Synced: 2025-01-29T14:12:36.473Z (11 months ago)
- Topics: contextapi, github, javascript, react
- Language: JavaScript
- Homepage: https://react-js-github.netlify.app/
- Size: 603 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React GitHub Profile Generator
## Description
The **React GitHub Profile Generator** is a web application that allows users to generate GitHub profile summaries using the GitHub API. Users can input a GitHub username to display detailed information, including repositories, followers, and basic user details. This app is built with React and showcases dynamic data fetching and presentation.
## Features
- Search for GitHub profiles by username
- Display profile picture, bio, and GitHub stats (e.g., repos, followers, following)
- Display user repositories, sorted by stars, forks, or other metrics
- Responsive and user-friendly design
- Dynamically fetch and display data using GitHub's REST API
## Technologies
- React
- GitHub API
- CSS (with optional libraries like Tailwind CSS or Bootstrap)
- Axios (for API requests)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/FREDVUNI/react-github-profile-generator.git
```
2. Navigate to the project directory:
```bash
cd react-github-profile-generator
```
3. Install dependencies:
```bash
npm install
```
4. Run the application:
```bash
npm start
```
## Usage
1. Enter a valid GitHub username in the search bar.
2. View user information and a list of repositories.
3. Filter or sort repositories based on stars, forks, or recent activity.
## Screenshots
## API Reference
This project uses the **GitHub REST API** to fetch user details and repositories.
- API Documentation: [GitHub REST API v3](https://docs.github.com/en/rest)
## Contributing
Contributions are welcome! Please submit a pull request or open an issue for discussion.