Skip to content

Harryahh/chat-with-page

 
 

Repository files navigation

Chat with page


🌟 Introduction

Welcome Developers and Contributors! This README is designed to provide a structured guide to help you dive into this project seamlessly.


🚀 Getting Started – 3 steps

MACOS/LINUX only! Windows coming soon

❗Pre-requisites❗

  • Ensure you have pnpm or npm packages installed on the computer
  • Ensure you have node.js installed on your computer.

1. Installation and Running of the endponoint (internal requirement)

# go to api-endpoint folder
cd api-endpoint

# Install dependencies
pnpm install

# Start the development server
pnpm run dev

🌐 API streaming server is ready: This is a core of streaming outputs directly from LLM model into API based version!

2. Chrome extension set up!

# go to chrome extension folder
cd chatwithpage-extension

# Install dependencies
pnpm install

# Get a build of the chrome extension ready
pnpm build

📂 Output Directory: All production files will be located in the build folder.

3. 🐪 Running Local Llama

Steps:

  1. Model Installation: Go to ollama.ai and follow installation instructions.
  2. Run Model: ollama run mistral
  3. Server Setup: Install litellm via pip: pip install litellm
  4. Start Server:
    litellm --model ollama/mistral --api_base http://localhost:11434 --temperature 0.3 --max_tokens 2048

🖥 Installing extension in Chrome

  1. Navigate: Go to chrome://extensions.
  2. Enable Developer Mode.
  3. Load Extension: Click "Load Unpacked" and navigate to build/chrome-mv3-dev or build/chrome-mv3-prod.

Loading Extension


🤝 Contributing

Current To-Do List:

  • Streamline local-stream repo.
  • Ensure compatibility with Vercel AI and OpenAI npm modules.

💡 Tech Stack

This extension is proudly built with Plasmo.


📘 Note: Your collaboration is highly valued. Let's build something awesome together!


Star History

Star History Chart

About

Chrome extension to chat with page using local LLM (llama, mistral 7B, etc)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 87.1%
  • JavaScript 4.3%
  • Shell 3.8%
  • CSS 3.7%
  • Makefile 0.5%
  • Dockerfile 0.5%
  • HTML 0.1%