Skip to content

nkendrick101/git-search

Repository files navigation

React GitHub Search App

This is a React application that allows users to search GitHub repositories by programming language and view their details. The app consists of two pages: the Search Page and the Details Page.

Requirements To run this app, you will need to have Node.js and npm installed on your machine.

Installation

Clone this repository to your local machine. Navigate to the project directory in your terminal. Run npm install to install the dependencies. Run npm start to start the app. Open your browser and go to http://localhost:3000 to view the app. Usage Search Page The Search Page is the landing page of the app. It allows users to search GitHub repositories by programming language.

To search for repositories:

Enter your search query in the search input field. Select the programming language you want to filter by from the dropdown menu. Click the "Search" button. The app will fetch data from the GitHub API and display the results in a list/grid view. Each item in the list/grid displays the repository name and a button to navigate to the Details Page.

Details Page

The Details Page displays the details of a selected repository.

To view the details of a repository:

Click the button of the repository you want to view on the Search Results list/grid. The app will fetch data from the GitHub API and display the following details: Repository name Clickable link to the owner's profile Repository description Star count Fork count Issue count License information (if any) Built With React - A JavaScript library for building user interfaces React Router - A popular routing library for React Tailwind CSS - A utility-first CSS framework GitHub API - A RESTful API for fetching data from GitHub Contributing Contributions are welcome! If you find any issues or want to suggest improvements, please open an issue or submit a pull request.

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

About

Created github search for code challenge

Resources

License

Stars

Watchers

Forks

Packages

No packages published