Skip to content

10_github_user_search

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

10_github_user_search

README.md

GitHub User Search

Overview

This is a GitHub User Search app built with React and Redux Toolkit. The app allows users to search for GitHub users, view detailed profiles, repositories, and followers. It also supports pagination and integrates with the GitHub API to fetch real-time data. The app ensures responsive design, making it usable across various devices and screen sizes.

Features

  • User Search: Search for GitHub users by their username.
  • User Detail View: View detailed information of a user, including their bio, repositories, and followers.
  • Repositories and Followers: Explore a user's repositories and followers.
  • Pagination: Navigate between pages of search results.
  • Error Handling: Gracefully handles loading errors and displays appropriate messages.
  • Responsive Design: Works well on different screen sizes and devices.

Installation

To run the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/ma3llim007/react_project/

  2. Navigate to the project directory:

    cd 01_github_user_search

  3. Install the required dependencies:

    yarn

  4. Start the development server:

    yarn run dev

    This will start the development server and open the project in your default browser at http://localhost:5173.

Usage

1. Searching for a GitHub User

  • Search: Type a GitHub username into the search bar.
  • View Results: Users matching the search query will appear on the page as cards.

2. Viewing User Details

  • Click on a User: Clicking on a user's card will display detailed information, such as their profile, bio, and more.
  • Repositories and Followers: Explore a user's top repositories and view their followers.

3. Pagination

  • Next/Previous: Navigate between pages of search results using the Next and Previous buttons.

Development

To contribute to this project:

  1. Clone the repository:

    git clone https://github.com/ma3llim007/react_project/

  2. Create a new branch for your feature or fix:

    git checkout -b feature/your-feature-name

  3. Make your changes and commit them:

    git add .
git commit -m "Describe your changes here"

  4. Push your changes to GitHub:

    git push origin feature/your-feature-name

  5. Open a pull request on GitHub and describe your changes.

Contributing

Contributions are welcome! If you find any bugs or have suggestions, please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • React for the frontend framework.
  • Redux Toolkit for state management.
  • GitHub API for the user data.
  • Tailwind CSS for utility-first styling.