Code Monkey home page Code Monkey logo

docmate's Introduction

DocMate

This project is a working full-stack application that lets you embed your personal PDF documents and ask questions about them. It is built upon langchain.js and was inspired by Eden Marco's python course LangChain- Develop LLM powered applications with LangChain on Udemy.

Progress

Currently, you can embed your documents and ask a single question. In the future, I plan to integrate a chat component where you can get a proper chat experience with chat history. Furthermore, I would like to make the tool responsive. Test it out here: DocMate.

Tutorial

A tutorial to embed your documents can be under setup-wiki. A tutorial on how to use the chat afterward can be under chat-wiki.

Run

Use node version 20.

Backend

Navigate to /backend and run:

npm install
npm run start

Frontend

Navigate to /frontend and run:

npm install
npm run dev

Either add the necessary keys to the .env. file or add them directly in the UI (they won't be saved and you would have to re-enter them).

VITE_PINECONE_API_KEY= *** Your Pinecone API Key ***
VITE_OPENAI_API_KEY= *** Your OpenAI API Key ***
VITE_SELECTED_LLM= *** Either 'GPT-3.5 Turbo' or 'Llama3 (Groq)'***
VITE_BACKEND_URL= *** URL of the backend. 'http://localhost:4008' in dev mode. ***

Stack

Both front- and backend are written in Typescript.

Frontend

Backend

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.