由 AI 提供支持的 GitHub 代码探索器 — 在几分钟内了解任何仓库,而非数天。
Jumping into a new, complex GitHub repository can feel like navigating an ocean without a map. That initial "where do I even start?" moment is a real blocker for developers who want to contribute to open-source.
GitForMe is an intelligent code exploration platform that solves this problem. Just paste a repository URL, and GitForMe generates a comprehensive, interactive dashboard that demystifies the codebase, helping you make your first contribution faster than ever.
GitForMe uses a microservice architecture to separate concerns and ensure scalability.
sentence-transformers), stores them in a FAISS index for fast retrieval, and streams responses from the language model (e.g., Azure OpenAI).Want to run GitForMe on your own machine? Here’s how.
Click to view step-by-step installation instructions for docker user
Clone the Repository
git clone https://github.com/herin7/gitforme.git
cd gitformeMake sure you have a .env file for the backend:
cd server
cp .env.devlopment .env
Uncomment the commnetes variables : REDIS_URL , MONGO_URL and comment the upper 2 same variables and add your GitHub OAuth credentials:
GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secretThen, start the server:
cd ..
docker compose up --buildSetup the LLM Server
cd ../llm-server
pip install -r requirements.txtCreate a .env file and add your Azure OpenAI credentials:
AZURE_OPENAI_KEY=your_key
AZURE_OPENAI_ENDPOINT=your_endpoint
AZURE_OPENAI_DEPLOYMENT=your_deployment_nameThen, start the server:
flask runSetup the Frontend
cd ../gitforme
npm installThen, start the development server:
npm run devYour local GitForMe instance should now be running at http://localhost:5173!
Click to view step-by-step installation instructions
Clone the Repository
git clone https://github.com/herin7/gitforme.git
cd gitformeSetup the Backend Server
cd server
npm installCreate a .env file and add your GitHub OAuth credentials:
GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secretThen, start the server:
npm startSetup the LLM Server
cd ../llm-server
pip install -r requirements.txtCreate a .env file and add your Azure OpenAI credentials:
AZURE_OPENAI_KEY=your_key
AZURE_OPENAI_ENDPOINT=your_endpoint
AZURE_OPENAI_DEPLOYMENT=your_deployment_nameThen, start the server:
flask runSetup the Frontend
cd ../gitforme
npm installCreate a .env.local file and add the URL of your backend server:
VITE_API_URL=http://localhost:3001Then, start the development server:
npm run devYour local GitForMe instance should now be running at http://localhost:5173!
We welcome contributions from the open-source community with open arms! If you're looking to help, here’s how you can get started.
git checkout -b feature/AmazingFeature)git commit -m 'Add some AmazingFeature')git push origin feature/AmazingFeature)Looking for an easy way to start? Check out these areas:
summarize_code function in app.py to support more languages.Distributed under the MIT License. See LICENSE.txt for more information.
Herin - @herin7
Project Link: https://github.com/herin7/gitforme
暂无开放 Issues,或尚未同步最近议题。