CodeLens AI 🔍

AI-powered code comprehension assistant that helps you understand any GitHub repository.

Have you ever struggled to understand the source code of a complex library, framework, or tool you wanted to use? Navigating through unfamiliar codebases can be a challenge, especially when dealing with large projects or code written by others. That's where CodeLens AI comes in – your AI-powered code comprehension assistant.

🚀 Features

• Code Comprehension: Ask questions about a GitHub repository's codebase, and CodeLens AI will provide clear explanations, powered by OpenAI's GPT-3.5-turbo language model
• GitHub Integration: Seamlessly fetch and analyze code directly from any public GitHub repository
• User-friendly Interface: Interact with CodeLens AI through a simple and intuitive Streamlit web interface
• Supported Languages: Python (more to come)

📋 Requirements

• Python 3.7 or later
• OpenAI API key
• GitHub Authentication Token (Optional, increases API rate limit)

🛠️ Installation

1. Clone the repository:

   git clone [YOUR_REPOSITORY_URL]
   cd codelens-ai

2. Create and activate a virtual environment:

   python -m venv venv
   # On Windows
   .\venv\Scripts\activate
   # On Unix or MacOS
   source venv/bin/activate

3. Install dependencies:

   pip install -r requirements.txt

4. Set up environment variables:

   # Create .env file
   cp .env.example .env
   # Edit .env with your API keys

🚦 Usage

1. Start the server:

   make server

2. In a new terminal, start the client:

   make client

The application will open in your default web browser.

🏗️ Project Structure

codelens-ai/
├── app/
│   ├── client/          # Streamlit frontend
│   ├── core/            # Core application logic
│   ├── services/        # External service integrations
│   └── main.py         # FastAPI application entry point
├── tests/              # Test suite
└── docs/              # Documentation

🔄 Development Workflow

1. Create a new branch for your feature:

   git checkout -b feature/your-feature-name

2. Make your changes and commit:

   git add .
   git commit -m "feat: add your feature description"

3. Push your changes:

   git push origin feature/your-feature-name

4. Create a Pull Request on GitHub

🎯 Roadmap

• Support for additional programming languages
• Integration with different LLM providers
• Advanced repository analysis features
• Integration with issue tracking systems
• StackOverflow integration for enhanced context

🤝 Contributing

Contributions are welcome! Please read our Contributing Guidelines for details on how to submit pull requests, report issues, and contribute to the project.

📜 License

This project is licensed under a custom license - see the LICENSE.md file for details.

🙏 Acknowledgments

• OpenAI for their powerful GPT models
• FastAPI for the efficient backend framework
• Streamlit for the intuitive frontend framework

---

Made with ❤️ for developers who love understanding code