Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/subhranil002/github-avatar-finder
GitHub Avatar Finder is a React web app enabling users to search and view GitHub avatars and profiles seamlessly. Powered by React Router, Axios, and Tailwind CSS ... ❤️
https://github.com/subhranil002/github-avatar-finder
avatar axios github github-api github-avatar github-avatar-finder profile-viewer reac-router react reactjs tailwind tailwindcss user-search
Last synced: 4 days ago
JSON representation
GitHub Avatar Finder is a React web app enabling users to search and view GitHub avatars and profiles seamlessly. Powered by React Router, Axios, and Tailwind CSS ... ❤️
- Host: GitHub
- URL: https://github.com/subhranil002/github-avatar-finder
- Owner: subhranil002
- License: mit
- Created: 2024-03-14T07:57:10.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-14T08:20:44.000Z (8 months ago)
- Last Synced: 2024-03-14T10:40:19.631Z (8 months ago)
- Topics: avatar, axios, github, github-api, github-avatar, github-avatar-finder, profile-viewer, reac-router, react, reactjs, tailwind, tailwindcss, user-search
- Language: JavaScript
- Homepage: https://avatar-finder-github.netlify.app
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Avatar Finder
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.
## Features
- **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.
## Installation
To run the GitHub Avatar Finder locally on your machine, follow these steps:
1. Clone the repository to your local machine:
```
git clone https://github.com/subhranil002/GitHub-Avatar-Finder.git
```
2. Navigate to the project directory:
```
cd GitHub-Avatar-Finder
```
3. Install dependencies using npm:
```
npm install
```
4. Start the development server:
```
npm run dev
```
5. Open your web browser and go to `http://localhost:5173` to view the application.
## Usage
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.
## Dependencies
The GitHub Avatar Finder project has the following dependencies:
- [React](https://reactjs.org/)
- [React Router](https://reactrouter.com/)
- [Axios](https://axios-http.com/)
- [Tailwind CSS](https://tailwindcss.com/)
## Contributing
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.
## License
This project is licensed under the [MIT License](https://github.com/subhranil002/GitHub-Avatar-Finder?tab=MIT-1-ov-file).
Made With ❤️