Giter VIP home page Giter VIP logo

farfalle's Introduction

Farfalle

Open-source AI-powered search engine. (Perplexity Clone)

Run your local LLM (llama3, gemma, mistral) or use cloud models (Groq/Llama3, OpenAI/gpt4-o)

Demo answering questions with llama3 on my M1 Macbook Pro:

local-demo.mp4

Please feel free to contact me on Twitter or create an issue if you have any questions.

๐Ÿ’ป Live Demo

farfalle.dev (Cloud models only)

๐Ÿ“– Overview

๐Ÿ›ฃ๏ธ Roadmap

  • Add support for local LLMs through Ollama
  • Docker deployment setup
  • Integrate with LiteLLM
  • Add support for searxng. Eliminates the need for external dependencies.

๐Ÿ› ๏ธ Tech Stack

๐Ÿƒ๐Ÿฟโ€โ™‚๏ธ Getting Started Locally

Prerequisites

  • Docker
  • Ollama (If running local models)
    • Download any of the supported models: llama3, mistral, gemma
    • Start ollama server ollama serve

Get API Keys

1. Clone the Repo

git clone [email protected]:rashadphz/farfalle.git
cd farfalle

2. Add Environment Variables

touch .env

Add the following variables to the .env file:

Required

TAVILY_API_KEY=...

Optional

# Cloud Models
OPENAI_API_KEY=...
GROQ_API_KEY=...

3. Run Containers

This requires Docker Compose version 2.22.0 or later.

docker-compose -f docker-compose.dev.yaml up -d

Visit http://localhost:3000 to view the app.

For custom setup instructions, see custom-setup-instructions.md

๐Ÿš€ Deploy

Backend

Deploy to Render

After the backend is deployed, copy the web service URL to your clipboard. It should look something like: https://some-service-name.onrender.com.

Frontend

Use the copied backend URL in the NEXT_PUBLIC_API_URL environment variable when deploying with Vercel.

Deploy with Vercel

And you're done! ๐Ÿฅณ

farfalle's People

Contributors

rashadphz avatar arsaboo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.