Skip to content

llaxmi/IdeaPulse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IdeaPulse

IdeaPulse is a web application that allows users to quickly check if ideas similar to theirs have been funded by Y Combinator (YC). The tool utilizes React.js, Vite, LangChain, and Vector Store to provide an efficient and user-friendly experience. Users can input their ideas, and the application will search through a database of funded projects to find relevant matches.

Screenshot

Screenshot

Features

  • Idea Submission: Users can submit their ideas for analysis.
  • Search Functionality: Quickly check if similar ideas have been funded by YC.
  • User-friendly Interface: Built with React.js for a seamless user experience.
  • Fast Performance: Utilizes Vite for rapid development and hot-reloading.
  • Ollama Integration: Leverages Ollama models for advanced text processing and comparison.

Technologies Used

  • LangChain: Core library for constructing prompts, output parsing, and document processing.
  • Ollama: Utilized for embeddings and similarity matching.
  • React & Vite: For building the front-end interface.
  • JavaScript: Core language for the backend logic.

🤝 Contributing to IdeaPulse

Appreciate your interest in contributing to IdeaPulse! Your contributions can make this project even more powerful and user-friendly. Whether you're fixing bugs, adding new features, or improving documentation, we welcome all contributions.

📝 Guidelines

Before you begin, please read and follow these guidelines:

  1. Issues & Feature Requests:

    • Descriptive titles: Use a clear and concise title that describes the problem or feature request.
    • Provide details: If reporting a bug, include steps to reproduce, expected behavior, and screenshots if possible.
  2. Fork the Repository:

    • Fork the repository by clicking on the 'Fork' button at the top-right corner of the IdeaPulse GitHub page.
    • Clone the forked repository to your local machine:
      git clone https://github.com/your-username/IdeaPulse.git
      cd IdeaPulse
  3. Set Up Local Environment: Ensure you have the following installed:

    • Node.js: v16 or higher

    • npm: Package manager

    • Vite: For building the React app

    • Ollama: Ensure the Ollama models are installed on your device.
      Visit the official Ollama website for installation instructions. Follow the guidelines provided there to set up Ollama on your device.

      After installation, you can verify that Ollama is installed correctly by running:

      ollama --version
      
  4. Set Up and Run Models with Ollama:

    • Start Ollama:
      ollama start
    • Pull a Model: To download the required models, run:
      llama3.1 - Used for text generation:
      ollama pull llama3.1  
      nomic-embed-text - Used for embedding text and vector search:
      ollama pull nomic-embed-text
      

Steps to Set Up and run on your local device:

  1. Install dependencies:
    npm run install:both
  2. Start Ollama on your device:
    ollama serve
  3. Run the development server:
    npm run dev

Visit localhost to see the app running.

Making Changes

  1. Create a new branch:
    git checkout -b feature/your-feature-name
    
  2. Make your changes and commit:
    git add .
    git commit -m "Add: Description of what you did"
    
  3. Push your branch:
    git push origin feature/your-feature-name
    

Submit a Pull Request (PR)

  • Go to your forked repository on GitHub.
  • Click on the New Pull Request button.
  • Provide a detailed description of your changes, linking any issues if applicable.

If you have any questions or need help, feel free to open an issue or reach out via email.

Happy coding! 🎉

About

IdeaPulse is a web application designed to help users quickly check if ideas similar to theirs have been funded by Y Combinator (YC).

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors