Skip to content

dbian/page-assist

 
 

Repository files navigation

Page Assist

Page Assist is an open-source Chrome Extension that provides a Sidebar and Web UI for your Local AI model. It allows you to interact with your model from any webpage.

Checkout the Demo:

Page Assist Demo

Features

  • Sidebar: A sidebar that can be opened on any webpage. It allows you to interact with your model and see the results.

  • Web UI: A web UI that allows you to interact with your model like a ChatGPT Website.

  • Chat With Webpage: You can chat with the webpage and ask questions about the content.

want more features? Create an issue and let me know.

Installation

Chrome Web Store

You can install the extension from the Chrome Web Store

Note: You can install the extension on any Chromium-based browser. It is not limited to Chrome.

Manual Installation

  1. Clone the repository
git clone https://github.com/n4ze3m/page-assist.git
cd page-assist
  1. Install the dependencies
npm install
  1. Build the extension
npm run build
  1. Load the extension
  • Open the Extension Management page by navigating to chrome://extensions.

  • Enable Developer Mode by clicking the toggle switch next to Developer mode.

  • Click the Load unpacked button and select the build directory.

Usage

Sidebar

Once the extension is installed, you can open the sidebar via context menu or keyboard shortcut.

Default Keyboard Shortcut: Ctrl+Shift+P

Web UI

You can open the Web UI by clicking on the extension icon which will open a new tab with the Web UI.

Default Keyboard Shortcut: Ctrl+Shift+L

Note: You can change the keyboard shortcuts from the extension settings on the Chrome Extension Management page.

Development

You can run the extension in development mode to make changes and test them.

npm run dev

This will start a development server and watch for changes in the source files. You can load the extension in your browser and test the changes.

Browser Support

Browser Sidebar Chat With Webpage Web UI
Chrome
Brave
Edge
Opera GX
Arc
Firefox

Local AI Provider

  • Ollama (Currently the only supported provider. More providers will be added in the future.)

Roadmap

  • Firefox Support
  • More Local AI Providers
  • More Features
  • More Customization Options
  • Better UI/UX

Contributing

Contributions are welcome. If you have any feature requests, bug reports, or questions, feel free to create an issue.

Support

If you like the project and want to support it, you can buy me a coffee. It will help me to keep working on the project.

Buy Me a Coffee at ko-fi.com

or you can sponsor me on GitHub.

License

MIT

Last but not least

Made in Alappuzha with ❤️

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.9%
  • Other 1.1%