GitHub Avatar Finder is a web application built with React that allows users to search for GitHub users and view their avatars along with some basic profile information.
- Search Users: Users can enter a GitHub username or a search query to find specific GitHub users.
- Avatar Display: Displays the avatar of the searched GitHub user along with their username.
- Profile Details: Users can click on a user's avatar to view more details about them, including their name, bio, followers count, and following count.
- Responsive Design: The application is designed to work seamlessly across various screen sizes, including desktops, tablets, and mobile devices.
To run the GitHub Avatar Finder locally on your machine, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/subhranil002/GitHub-Avatar-Finder.git -
Navigate to the project directory:
cd GitHub-Avatar-Finder -
Install dependencies using npm:
npm install -
Start the development server:
npm run dev -
Open your web browser and go to
http://localhost:5173to view the application.
Once the application is running locally, you can use it as follows:
- Enter a GitHub username or search query in the search input box.
- View the list of GitHub users matching the search query.
- Click on a user's avatar to view more details about them.
The GitHub Avatar Finder project has the following dependencies:
Contributions to GitHub Avatar Finder are welcome! If you find any bugs, have feature requests, or would like to contribute code, please feel free to open an issue or submit a pull request.
This project is licensed under the MIT License.
Made With ❤️