React Github Explorer

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Features
• Developed By

About the Project

A React application that allows users to explore trending GitHub repositories. The application features a responsive design, custom data table, search functionality, and sorting functionality.

Glimps of our Project

Built With

• Frontend: React
• Library:
  • Tailwind CSS for general CSS
  • React-redux for state management

Getting Started

Prerequisites

General:

1. Git:

   • Make sure Git is installed on your system. You can download it from here.

2. Node.js and npm:

   • Install npm from https://nodejs.org/.

Frontend:

1. React:

   • Ensure you have a basic understanding of React.
   • Documentation: https://reactjs.org/docs/getting-started.html

2. npm Packages:

   • Navigate to the github-explorer directory and install dependencies using npm install.

Installation

1. Clone the Repository:

   git clone https://github.com/UdayGohel/github-explorer.git

2. Navigate to Project Directory:

   cd github-explorer

3. Install Dependencies for React JS:

   npm install

4. Run the Application for Front-end:

   npm start

Usage

Browsing Trending Repositories:

• Discover popular repositories across different programming languages.

Deep-Dives into Specific Repositories:

• Click on a repository to view its basic details like description, stars, forks, and owner.

Exploring Top Issues:

• View the top 5 reported issues associated with a repository.

Features

Responsive design:

• The application adjusts its layout to fit different screen sizes

Custom data table:

• The application displays trending repositories in a custom data table that allows for sorting and searching

Search functionality:

• Users can search for repositories by name or description or topics.

Sorting functionality:

• Users can sort repositories by stars, forks, or updated.

Error Handling:

• Displaying user-friendly error messages.

Rate Limiting:

• If the Github API has rate limits, implement mechanisms to handle them gracefully.

Pagination:

• Implement pagination to handle a large number of repositories efficiently.

Loading State:

• Show a loading indicator while fetching data to improve user experience.

Developed By

• Uday Gohel