An open API service indexing awesome lists of open source software.

https://github.com/karan-develops/get-git


https://github.com/karan-develops/get-git

fun github nextjs

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Get Git 🔥

# How it Works

Get Git is an interactive web application that allows users to explore, compare, and have fun with GitHub profiles. Try Getting roasted by AI 😈 Built with Next.js, React, and powered by various APIs including GitHub and Google's Gemini AI, this project offers a unique way to engage with GitHub data.

![banner](https://raw.githubusercontent.com/Karan-develops/Get-Git/refs/heads/main/App.png)

## Features

- **Profile Explorer**: View detailed GitHub user profiles, including repositories, commit history, and language statistics.
- **Battle Mode**: Compare two GitHub users and see who comes out on top based on various metrics.
- **AI-Powered Roasts**: Get humorous, AI-generated roasts of GitHub profiles using Google's Gemini AI.
- **Data Visualization**: Interactive charts and graphs to visualize user statistics and activity.
- **GitHub Timeline**: View a user's recent GitHub activity in a timeline format.

## Technologies Used

- [Next.js](https://nextjs.org/) - React framework for building the web application
- [React](https://reactjs.org/) - JavaScript library for building user interfaces
- [TypeScript](https://www.typescriptlang.org/) - Typed superset of JavaScript
- [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework
- [shadcn/ui](https://ui.shadcn.com/) - Re-usable components built with Radix UI and Tailwind CSS
- [Framer Motion](https://www.framer.com/motion/) - Animation library for React
- [Recharts](https://recharts.org/) - Charting library built with React components
- [GitHub API](https://docs.github.com/en/rest) - For fetching GitHub user and repository data
- [Google Generative AI (Gemini)](https://ai.google.dev/) - For generating AI-powered roasts

### Environment Variables

| Variable | Description |
| :-------------------- | :-------------------------------------- |
| `GITHUB_ACCESS_TOKEN` | Get this from github developer settings |
| `GOOGLE_AI_API_KEY` | Get from Google's Api |

## Getting Started

### Installation

To run this project locally, follow these steps:

1. Clone the repository:
`git clone https://github.com/Karan-develops/Get-Git`
2. Install the dependencies:
`npm install`
3. Set up environment variables: - Create a `.env` file, - Add the Variables given in above Table.
4. Start the development server:
`npm run dev`

## Usage

- Open your browser and navigate to `http://localhost:3000`.
- Explore the features and functionalities of the Get Git.

--- **_Enjoy_** **😊** ---