Open Source Component Searcher

Welcome to the Open Source Component Searcher project! This tool is designed to help you seamlessly find compatible open-source components for your projects. Whether you need to integrate a multi-file uploader, authentication system, or any other feature into your web application, this searcher leverages advanced technologies to ensure you find the best possible solutions quickly and efficiently.

Demo

Screen.Recording.2024-06-02.at.11.21.39.AM.mov

RAG Implementation

Table of Contents

1. Introduction
2. Features
3. Technologies Used
4. Installation
5. Usage
6. Contributing
7. License

Introduction

The Open Source Component Searcher is designed to help developers enhance their web applications by finding compatible open-source components. This tool uses vectorization and search algorithms to analyze your existing project and identify the best components available on GitHub that match your requirements.

Features

• Project Vectorization: Vectorizes your existing project repository to understand its structure and dependencies.
• Query Generation: Utilizes Upstage to generate potential search queries tailored to your project needs.
• GitHub Scraping: Searches GitHub for open-source projects and components that match the generated queries.
• Vector Storage: Stores scraped data in a MongoDB Atlas vector store for efficient querying and retrieval.
• Component Matching: Queries the vector store to find the most compatible open-source components for your project.

Technologies Used

• Next.js: Framework used for building the web application.
• LangChain: For vectorizing your project repository.
• MongoDB Atlas: As the vector store for storing and retrieving project vectors.
• Upstage: For generating search queries based on your project requirements.
• GitHub API: For searching and scraping open-source components.

Installation

To get started with the Open Source Component Searcher, follow these steps:

1. Clone the Repository:

   git clone https://github.com/ashmitg/mongodbhackathon
   cd mongodbhackathon

2. Install Dependencies:

   npm install

3. Configure MongoDB Atlas:

   • Set up a MongoDB Atlas account and create a new cluster.
   • Obtain your MongoDB connection string and update the .env file with your credentials.

4. Run the Application:

   npm run dev

Usage

1. Vectorize Your Project: Upload your project repository to the tool to start the vectorization process.
2. Generate Search Queries: Specify the features you need (e.g., multi-file uploader), and the tool will generate relevant search queries.
3. Search GitHub: The tool will search GitHub using the generated queries and scrape the results.
4. Store and Query Vectors: The scraped data will be stored in the MongoDB Atlas vector store.
5. Find Compatible Components: Query the vector store to find the most compatible open-source components for your project.

Contributing

We welcome contributions from the community! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make your changes and commit them (git commit -m 'Add your feature').
4. Push to the branch (git push origin feature/your-feature).
5. Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

By using the Open Source Component Searcher, you can save time and ensure that the components you integrate into your web application are highly compatible and meet your specific needs. We hope you find this tool useful and look forward to your feedback and contributions!