Github Explorer
Github Explorer is a web application that allows users to discover trending GitHub repositories and get AI-powered insights. Users can search for repositories, filter by language, and generate summaries of a repository's README file using generative AI.
Features
- Trending Repositories: View a list of trending GitHub repositories.
- Search: Search for repositories by keyword.
- Filtering: Filter repositories by programming language.
- Sorting: Sort repositories by stars, forks, last updated, and help wanted issues.
- AI Summaries: Generate an AI-powered summary of a repository's README file using Firebase Genkit.
- Responsive Design: The application is designed to work on both desktop and mobile devices.
Architecture
Github Explorer is built with the following technologies:
- Frontend:
- Next.js - A React framework for building server-side rendered and static web applications.
- React - A JavaScript library for building user interfaces.
- Tailwind CSS - A utility-first CSS framework for rapid UI development.
- Shadcn/ui - A collection of re-usable UI components.
- Backend:
- Next.js API Routes - Used for server-side logic and API endpoints (specifically, Next.js Server Actions).
- AI:
- API:
- GitHub API - Used to fetch repository data and README files.
- Deployment:
Getting Started
To run the application locally, you will need to have Node.js and npm installed.
Clone the repository:
git clone <repository-url>
Install dependencies:
npm install
Run the development server:
npm run dev
This will start the Next.js development server on http://localhost:9002.
Run the Genkit development server:
In a separate terminal, run the following command to start the Genkit development server:
npm run genkit:dev
This will start the Genkit server and make the AI flows available to the application.