oyi77 / github-explorer

A Github User Explorer

GitHub Repositories Explorer

Description

GitHub Repositories Explorer is a React application that integrates with the GitHub API to allow users to search for up to 5 GitHub users with a username similar to the value entered in the text input. Upon clicking a user, the application displays the repositories for the selected GitHub user. There is no limit on the number of displayed repositories.

API Documentation: GitHub API v3

Features

• Search for GitHub users with similar usernames
• Display repositories for selected GitHub user
• Responsive design for both desktop and mobile view
• Good UX practices, including keyboard events handling and loading states
• Proper error handling for a seamless user experience

Technologies Used

• React
• TypeScript
• [Other libraries of your choice for forms, styling, testing, state management, etc.]

Installation and Usage

1. Clone the repository.
2. Install the dependencies using npm install.
3. Start the development server with npm start.
4. Access the application at http://localhost:3000.

Deployment

The application is hosted on GitHub Pages and can be accessed publicly at https://your-github-username.github.io/your-repository-name.

How to Contribute

We welcome contributions to improve the GitHub Repositories Explorer. To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature: git checkout -b feature-name
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin feature-name
5. Submit a pull request.

Bugs and Issues

If you encounter any bugs or have suggestions for improvements, please open an issue.

License

MIT License

Acknowledgements

[Include any acknowledgements or credits for libraries, tutorials, or other resources used in the project]

---

By Muchamamd Fikri Izzuddin - Connect with me on LinkedIn