Git-Friend
GitFriend is an AI-powered GitHub companion built with React, TypeScript, and Firebase. It helps users resolve Git/GitHub issues through smart AI chat, generate
What is Git-Friend?
GitFriend is an AI-powered GitHub companion built with React, TypeScript, and Firebase. It helps users resolve Git/GitHub issues through smart AI chat, generates dynamic and professional README files, and adds commit emojis to enhance commit history.
Overview of Git-Friend
What it is
GitFriend is an AI-powered GitHub companion built with React, TypeScript, and Firebase. It helps users resolve Git/GitHub issues through smart AI chat, generates dynamic and professional README files, and adds commit emojis to enhance commit history. The project is open source under the MIT license and is hosted at https://gitfriend.xyz.
Key features
- Google Authentication: Securely log in using your Google account to access all features.
- AI Chat Integration: Get assistance with Git commands, project setup, and more through integrated AI chat.
- README Generation: Automatically generate professional READMEs for your projects with customizable templates.
- Gitmoji Support: Easily add expressive emojis to your commit messages following the Gitmoji convention.
- User-friendly Interface: Intuitive UI that makes navigation and usage a breeze.
- React Components: Utilizes various React components for interactive and responsive user experience.
Use cases
- For Open Source Contributors: Quickly generate professional READMEs for open source projects, making them more accessible to potential contributors.
- For Team Leads: Maintain consistency across team repositories by using standardized README templates and commit message practices with Gitmoji.
- For GitHub Beginners: Get assistance with Git commands and best practices through the AI chat feature.
- For Documentation Teams: Streamline the process of creating and updating documentation with AI-powered README generation and formatting.
Getting started
Prerequisites: Node.js (v16 or later), npm (v8 or later), a Google account for authentication, and various API keys. Installation: 1. Clone the repository: bash git clone https://github.com/krishn404/Git-Friend.git 2. Navigate into the project directory: bash cd Git-Friend 3. Install the dependencies: bash npm install If dependency errors occur, try: bash npm install --legacy-peer-deps 4. Configure environment variables in a .env.local file (see repository README for details). 5. Start the development server: bash npm run dev Access Git-Friend at http://localhost:3000.
License and pricing
The project is open source under the MIT license. Pricing is not stated; the metadata indicates it is open source.
Based on the project's public README and repository metadata.