Skip to content

A React app that searches and displays detailed GitHub user profiles, including repositories, followers, following, and gists. Using the Github API.

License

Notifications You must be signed in to change notification settings

Lalitkumar4/github-user-explorer

Repository files navigation

Github User Explorer

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

📦 Technologies

  • React.js
  • Context API
  • Tailwind CSS
  • React Router
  • Axios
  • Github API
  • Vite
  • React Icons
  • React Github Calendar
  • React Tooltip
  • Swiper

🚀 Features

  • 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.

⚡Running the project

To run the project in your local environment, follow these steps:

  1. Clone the repository on your local machine: git clone https://github.com/Lalitkumar4/github-user-explorer
  2. Navigate to the project directory.
  3. Run npm install in the project directory to install the necessary dependencies.

4. Environment Variables

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.

  1. To start the project, use npm run dev.
  2. To access the app, open your web browser and navigate to http://localhost:3000 (or the address displayed in your console).

🎥 Preview

video.mp4

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! If you want to contribute to this project, please fork the repository and make a pull request.

About

A React app that searches and displays detailed GitHub user profiles, including repositories, followers, following, and gists. Using the Github API.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published