Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 1.09 KB

README.md

File metadata and controls

56 lines (35 loc) · 1.09 KB
Raw

Search Github Users Project

This project for searching GitHub repositories and their details

About

The Search Github Users Project allows users to search for GitHub repositories by entering a keyword. It retrieves repository data using the GitHub REST API and displays the results dynamically on the web page.

Tools and Technologies Used

  • JSX
  • Tailwind
  • Axios
  • Toaster
  • React Icons
  • GitHub REST API
  • SEO Friendly

Installation

To run the project locally, follow these steps:

  1. Clone the repository to your local machine using the following command:

    git clone https://github.com/waqarahmad134/Search-Github-Users.git

  2. Navigate to the project directory:

    cd Search-Github-Users

  3. Install all node modules.

    npm i

  4. Start react project using

    npm run dev

  5. Project will start running at http://localhost:5173/

Usage

  • Enter a keyword in the search input field.
  • Press the "Search" button to retrieve GitHub repositories related to the keyword.
  • View the search results displayed on the page.