Skip to content
/ gity Public

Gity AI Assistant is a web-based tool that allows users to analyze and interact with a Git repository using AI.

License

Notifications You must be signed in to change notification settings

vs182/gity

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Git Repository AI Assistant

📌 Overview

Git Repository AI Assistant is a web-based tool that allows users to analyze and interact with a Git repository using AI. By entering a Git repository URL, the system clones the repository, processes its code, and enables users to ask questions related to the repo. The AI provides answers based on the embedded repository data.

This project is powered by a Retrieval-Augmented Generation (RAG) system using a local LLM (Large Language Model) and a vector database (FAISS) for efficient search and retrieval.


🚀 Features

  • Clone & Process Git Repositories: Enter a GitHub repository URL, and the system will fetch and process the code.
  • LLM-powered Q&A: Ask questions about the repository, and the AI will respond based on the code and documentation.
  • Local & Secure: Runs completely locally without requiring cloud-based AI services.

🛠️ Tech Stack

  • Frontend: React (Vite), TailwindCSS
  • Backend: Python (FastAPI)
  • LLM & AI Processing: FAISS for vector search, LLaMA/Mistral for LLM-based responses
  • Dependencies:
    • Node.js (for frontend)
    • Python 3+ (for backend & AI model)

🔧 Installation & Setup

Follow these steps to set up and run the project on your local machine:

Step 1: Set Up the Frontend

  1. Navigate to the frontend folder:
    cd frontend
  2. Install dependencies:
    npm i
  3. Start the development server:
    npm run dev

Step 2: Start the Backend

  1. Navigate to the backend folder:
    cd backend
  2. Run the backend services:
    python main.py
    python llm.py

Step 3: Use the Application

  1. Open your browser and go to:
    http://localhost:3000
    
  2. Enter a Git repository URL and start interacting with the AI!

📝 Future Enhancements

  • Automatic Repo Updates: Periodically sync and update indexed repositories.
  • Code Change Impact Analysis: Identify the effects of code modifications.
  • Refactoring Suggestions: Use AI to recommend code improvements.

🛠 Troubleshooting

  • If you encounter package installation issues, try deleting node_modules and running npm install again.
  • Ensure you have Python 3+ installed and the required libraries (pip install -r requirements.txt).
  • Check that ports 3000 (frontend) and 8000 (backend) are available.

📜 License

This project is open-source under the MIT License.


🙌 Contributions

Feel free to contribute by creating pull requests, reporting issues, or suggesting features!

About

Gity AI Assistant is a web-based tool that allows users to analyze and interact with a Git repository using AI.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published