/sankofa

Sankofa is a browser extension that allows you to store pages you visit and query them using Vectara.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Sankofa: A Browser Extension by Vectara 🚀

Sankofa, which means “to retrieve" in the Twi language of Ghana, is a browser extension created by Vectara. Its goal is to demonstrate the use of Vectara and its powerful semantic search and summarization capabilities.

When using Sankofa you can index web pages you visit (or instruct Sankofa to do so automatically). After pages are indexed in a Vectara corpus, you can us Sankofa to find pages you've visited before, ask questions about the content of pages you had visited or find pages similar to a page you are now visiting in your browser.

Installation

Using the pre-packaged zip files

Google Chrome

  • Download the sankofa-chrome and unzip.
  • Open chrome://extensions/ in your Chrome browser.
  • Enable Developer mode in the top-right corner.
  • Click on Load unpacked and select sankofa-chrome folder.
  • Click on the extension Icon in the top right corner.
  • Pin the sankofa extension to make it visible in the toolbar.

FireFox

  • Download the sankofa-firefox and unzip it.
  • Open about:debugging#/runtime/this-firefox in your firefox browser.
  • Click on Load Temporary Add-on and select manifest.json file from sankofa-firefox folder.
  • Click on the extension Icon in the top right corner.
  • Click on the settings icon and pin the sankofa extension to make it visible in the toolbar.

Microsoft Edge

  • Download the sankofa-edge and unzip it.
  • Click on the ... on the top-right to open the context menu, and click “extensions” Then click “Manage Extensions”.
  • In the extensions screen turn on “developer mode”.
  • Click on Load unpacked and select the sankofa-edge folder.
  • In the extensions icon in the Edge toolbar, you can click the little “eye” icon to ensure Sankofa is showing as its own Icon.

Use the repo

Pre-requisites:

To get started, the minimum requirement is to install npm and node. That's it!

To install Sankofa from this repository, please follow these steps:

  1. Clone the GitHub Repository 
    git clone https://github.com/vectara/sankofa.git
cd sankofa
  2. Install dependencies 
    npm install

Building the browser extension and installing it for your browser:

Google Chrome

  • Build with npm run build
  • Open chrome://extensions/ in your Chrome browser.
  • Enable Developer mode in the top-right corner.
  • Click on Load unpacked and select the chrome-mv3-prod folder from the build folder.
  • Click on the extension Icon in the top right corner.
  • Pin the sankofa extension to make it visible in the toolbar.

Firefox

  • Build with npm run build -- --target=firefox-mv2
  • Open about:debugging#/runtime/this-firefox in your firefox browser.
  • Click on Load Temporary Add-on and select manifest.json file from build/firefox-mv2-prod folder.
  • Click on the extension Icon in the top right corner.
  • Click on the settings icon and pin the sankofa extension to make it visible in the toolbar.

Microsoft Edge

  • Build with npm run build -- --target=edge-mv3
  • Click on the ... on the top-right to open the context menu, and click “extensions” Then click “Manage Extensions”.
  • In the extensions screen turn on “developer mode”.
  • Click on Load unpacked and select the edge-mv3-prod folder from the build folder.
  • In the extensions icon in the Edge toolbar, you can click the little “eye” icon to ensure Sankofa is showing as its own Icon.