Skip to content

This repository contains a web application that allows users to search and explore GitHub profiles using the GraphQL API. It showcases efficient state management and a responsive design, making it a valuable tool for developers. 🐙✨

Notifications You must be signed in to change notification settings

Marko1889/Search-Github-Users-Explorer--ReactVite-GraphQL

Repository files navigation

Search GitHub Users Explorer 🌐

GitHub release

Welcome to the Search GitHub Users Explorer repository! This project is a modern web application designed to search and explore GitHub users using the GitHub GraphQL API. Built with a combination of powerful technologies, this app showcases advanced features and a clean, responsive user interface.

Table of Contents

Introduction

In today's digital landscape, accessing user information from platforms like GitHub is crucial for developers, researchers, and enthusiasts alike. The Search GitHub Users Explorer app provides an intuitive interface to search for GitHub users and explore their profiles. With the power of the GitHub GraphQL API, users can fetch detailed information efficiently.

Technologies Used

This project utilizes a variety of modern technologies to ensure a robust and smooth experience:

  • React: A JavaScript library for building user interfaces.
  • Vite: A fast build tool that improves the development experience.
  • TypeScript: A typed superset of JavaScript that enhances code quality.
  • Tailwind CSS: A utility-first CSS framework for styling.
  • Apollo Client: A powerful tool for managing GraphQL data.
  • shadcn/ui: A collection of components for building beautiful user interfaces.

Features

The Search GitHub Users Explorer application comes packed with features that enhance user experience:

  • User Search: Quickly find GitHub users by their usernames.
  • User Profiles: View detailed profiles that include repositories, followers, and more.
  • Data Visualization: Charts and graphs to visualize user data.
  • Responsive Design: A clean layout that works on all devices.
  • Loading Skeletons: Smooth transitions while data loads.
  • Toast Notifications: Real-time feedback on user actions.

Installation

To set up the project locally, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/Marko1889/Search-Github-Users-Explorer--ReactVite-GraphQL.git
  2. Navigate to the Project Directory:

    cd Search-Github-Users-Explorer--ReactVite-GraphQL
  3. Install Dependencies:

    npm install
  4. Start the Development Server:

    npm run dev
  5. Open Your Browser: Visit http://localhost:3000 to view the application.

Usage

Once the application is running, you can use the search bar to find GitHub users. Type in a username, and the app will display relevant profiles. Click on a profile to view detailed information, including repositories and statistics.

Example Search

  • Search for a User: Enter a username like torvalds to explore Linus Torvalds’ profile.
  • View Repositories: Check the repositories owned by the user and explore their contributions.

Contributing

We welcome contributions to improve the project. To contribute:

  1. Fork the Repository: Click the "Fork" button at the top right.
  2. Create a Branch:
    git checkout -b feature/YourFeature
  3. Make Your Changes: Edit files and commit your changes.
  4. Push to Your Fork:
    git push origin feature/YourFeature
  5. Create a Pull Request: Go to the original repository and click "New Pull Request."

License

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

Release Information

For the latest releases, visit the Releases section. Here, you can download the latest version and see the changes made in each release.

Release Information

Conclusion

The Search GitHub Users Explorer application is a powerful tool for anyone looking to explore GitHub users. With its modern design and efficient data management, it provides a seamless experience for users. Whether you're a developer, researcher, or just a GitHub enthusiast, this application is designed to meet your needs.

Feel free to explore the code, contribute, and share your thoughts. Happy coding!

About

This repository contains a web application that allows users to search and explore GitHub profiles using the GraphQL API. It showcases efficient state management and a responsive design, making it a valuable tool for developers. 🐙✨

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •