Skip to content

pgadd/DevScribe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DevScribe: AI Codebase Navigator

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.

Features

  • 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.

Tech Stack

  • Frontend: React, Axios
  • Backend: Python, FastAPI, LangChain, Google Gemini, FAISS

Setup and Running

Backend

  1. Create a virtual environment: python -m venv venv and activate it.
  2. Install dependencies: pip install -r requirements.txt
  3. Get a Google API Key: Go to Google AI Studio to create your API key.
  4. Create a .env file in the root DevScribe/ directory and add your Google API key: GOOGLE_API_KEY="your_api_key_here"
  5. Run the server from the backend/ directory: uvicorn main:app --reload The backend will be running at http://localhost:8000.

Frontend

  1. Navigate to the frontend/ directory.
  2. Install dependencies: npm install
  3. Start the application: npm run dev The frontend will be running at http://localhost:5173.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors