DevScribe is a hackathon project that allows developers to chat with any public GitHub repository. It uses AI to understand the structure and logic of the code, enabling users to ask complex questions in plain English and receive context-aware answers.
- Analyze any public GitHub repository via its URL.
- Ask questions about the codebase, such as "How is user authentication implemented?" or "Explain the database schema."
- Receive answers generated by an AI that has read the entire repository.
- Frontend: React, Axios
- Backend: Python, FastAPI, LangChain, Google Gemini, FAISS
- Create a virtual environment:
python -m venv venvand activate it. - Install dependencies:
pip install -r requirements.txt - Get a Google API Key: Go to Google AI Studio to create your API key.
- Create a
.envfile in the rootDevScribe/directory and add your Google API key:GOOGLE_API_KEY="your_api_key_here" - Run the server from the
backend/directory:uvicorn main:app --reloadThe backend will be running athttp://localhost:8000.
- Navigate to the
frontend/directory. - Install dependencies:
npm install - Start the application:
npm run devThe frontend will be running athttp://localhost:5173.