Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.28 KB

README.md

File metadata and controls

74 lines (49 loc) · 2.28 KB
Raw

GitHub Profile

image

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

Previous UI (Version 1.0):

Link to Previous UI Deployment

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

My Skills

Setup

To run this project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/sahilatahar/github-profile.git

  2. Navigate to the project folder:

    cd github-profile

  3. Install dependencies:

    npm install

  4. Start the development server:

    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.

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!