https://github.com/sahilatahar/github-profile
Explore GitHub Page: Showcasing user data via GitHub API integration, alongside an enhanced user interface for a richer browsing experience.
https://github.com/sahilatahar/github-profile
github github-api github-profile github-profile-info javascript react reactjs vite
Last synced: 11 months ago
JSON representation
Explore GitHub Page: Showcasing user data via GitHub API integration, alongside an enhanced user interface for a richer browsing experience.
- Host: GitHub
- URL: https://github.com/sahilatahar/github-profile
- Owner: sahilatahar
- License: mit
- Created: 2023-05-07T22:03:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T06:20:52.000Z (about 2 years ago)
- Last Synced: 2023-11-22T04:24:09.407Z (about 2 years ago)
- Topics: github, github-api, github-profile, github-profile-info, javascript, react, reactjs, vite
- Language: JavaScript
- Homepage: https://sahilatahar.github.io/github-profile/
- Size: 683 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GitHub Profile
Explore GitHub Page: Showcasing user data via GitHub API integration, alongside an enhanced user interface for a richer browsing experience.
## Live Demo
### **New UI (Version 2.0):**
[Link to New UI Deployment](https://sahilatahar.github.io/github-profile/)
### **Previous UI (Version 1.0):**
[Link to Previous UI Deployment](https://github-user-data-fetcher.netlify.app/)
## Features
- **User-Friendly Interface**: An intuitive platform that makes retrieving GitHub user information straightforward.
- **Comprehensive Data Display**: Provides detailed user information, including name, bio, followers, repositories, and followings.
- **Ease of Use**: Simple and efficient steps to fetch and display data with minimal effort.
## How to use
1. Go to the website and type your github username.
2. Select suggested profile.
3. The website will display the user's information including name, bio, followers, repositories, and followings.
## Technologies Used
[]()
## Setup
To run this project locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/sahilatahar/github-profile.git
```
2. **Navigate to the project folder:**
```bash
cd github-profile
```
3. **Install dependencies:**
```bash
npm install
```
4. **Start the development server:**
```bash
npm run dev
```
5. **Access the application:**
Open your web browser and go to `http://localhost:5173` to view the project.
## License
This project is licensed under the [MIT License](LICENSE).
## Contribution
Contributions are welcome! To contribute to this project, follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/awesome-feature`).
3. Make modifications or add new features.
4. Commit your changes (`git commit -am 'Add new feature'`).
5. Push to the branch (`git push origin feature/awesome-feature`).
6. Create a new Pull Request.
Please ensure that your Pull Request adheres to the project's guidelines and coding conventions. Any contributions you make will be greatly appreciated!