GitHub User Dashboard is a React application that allows users to search for a Github user and see their profile information, repositories, followers and more.
- Search for a Github user by their username.
- View user profile information such as avatar, name, company, bio, location, followers, following, public repositories, and public gists.
- View user repositories, including the repository name, description, number of stars, and number of forks.
- View user followers and following.
- View user's most starred repositories, most forked repositories, and top language.
- Loading spinner displayed while data is being fetched from Github API.
The following technologies were used to build this project:
- React: A popular JavaScript library for building user interfaces.
- Axios: A promise-based HTTP client for making API requests.
- GitHub REST API: Used to fetch user profile information, repositories, and followers data.
- React Context API: Used for state management and sharing data across components.
- CSS: Used for styling the user interface
To run the GitHub User Dashboard locally on your machine, follow these steps:
- Clone the GitHub repository to your local machine.
- Navigate to the project directory using a terminal or command prompt.
- Install the dependencies by running the command npm install or yarn install.
- Start the development server by running the command npm start or yarn start.
- Open a web browser and go to http://localhost:3000 to access the application.
- Enter a GitHub username in the search bar to fetch and display the user's profile information, repositories, and followers.
- Click on the repository cards to view detailed information about each repository, such as forks, stars, and top language used.
- Click on the follower cards to view detailed information about each follower, such as their username and avatar.
Contributions to this project are welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue.
This project is open-source and available under the MIT License.
This project was created as part of a coding challenge and is not affiliated with or endorsed by GitHub. Special thanks to GitHub for providing the API for fetching user data.