GitHub User Explorer is a React app that lets you search for GitHub users and see their profiles, repositories, followers, following, and gists. It connects with the GitHub API and offers a simple interface for browsing user data.
👉 Live Demo: Github User Explorer
React.js
Context API
Tailwind CSS
React Router
Axios
Github API
Vite
React Icons
React Github Calendar
React Tooltip
Swiper
- User Search: Search for any GitHub username.
- User Profile: View detailed information about a user, such as their bio, location, number of repositories, followers, following, account creation date, etc.
- Repositories: View a user's public repositories, including the most recent ones in a slider.
- Followers and Following: View a list of users who follow or are followed by the selected user.
- Gists: View a user's public gists.
- Pagination: Navigate through pages of search results, followers, following, repositories, and gists.
- Error Handling: Display user-friendly error messages for various error scenarios.
To run the project in your local environment, follow these steps:
- Clone the repository on your local machine:
git clone https://github.com/Lalitkumar4/github-user-explorer
- Navigate to the project directory.
- Run
npm install
in the project directory to install the necessary dependencies.
Create a .env
file in the root directory and add the following environment variables:
VITE_GITHUB_URL=https://api.github.com
VITE_GITHUB_TOKEN=your_github_token
Replace your_github_token
with your actual GitHub token.
- To start the project, use
npm run dev
. - To access the app, open your web browser and navigate to http://localhost:3000 (or the address displayed in your console).
This project is licensed under the MIT License.
Contributions are welcome! If you want to contribute to this project, please fork the repository and make a pull request.