RicardoJ / github-user-search

GitHub User Search

GitHub User Search is a simple web application that allows you to search for users on GitHub and view their basic information. You can see details such as their avatar, name, location, and bio.

Features

• Search for GitHub users by username.
• View detailed user information, including their avatar, name, location, and bio.
• Basic repository statistics, including the number of public repositories, followers, and following.

How to Use

1. Clone this repository: git clone https://github.com/YourUsername/GitHubUserSearch.git
2. Install dependencies: npm install
3. Run the application: npm run dev
4. Open your browser and go to http://localhost:5173

Storybook

This project also includes a Storybook instance to showcase UI components in isolation. To run Storybook, follow these steps:

1. Install Storybook globally: npm install -g storybook
2. Navigate to the project directory.
3. Run Storybook: npm run storybook
4. Open your browser and go to http://localhost:6006

Unit Testing

GitHub User Search includes unit tests to ensure the reliability of its components. To run the tests, follow these steps:

1. Install dependencies (if not done already): npm install
2. Run the unit tests: npm test

Technologies Used

• React + Vite
• Material-UI
• Storybook
• GitHub API

---

Created by RicardoJ