https://github.com/vectara/sankofa
Sankofa is a browser extension that allows you to store pages you visit and query them using Vectara.
https://github.com/vectara/sankofa
Last synced: 2 months ago
JSON representation
Sankofa is a browser extension that allows you to store pages you visit and query them using Vectara.
- Host: GitHub
- URL: https://github.com/vectara/sankofa
- Owner: vectara
- License: apache-2.0
- Created: 2023-12-28T17:17:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-14T17:49:02.000Z (over 1 year ago)
- Last Synced: 2025-04-28T13:55:35.454Z (6 months ago)
- Language: TypeScript
- Homepage: https://vectara.com
- Size: 8.78 MB
- Stars: 58
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Sankofa: A Browser Extension by Vectara 🚀
[Sankofa](https://en.wikipedia.org/wiki/Sankofa), which means “to retrieve" in the [Twi language](https://en.wikipedia.org/wiki/Twi_language) of [Ghana](https://en.wikipedia.org/wiki/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](https://github.com/vectara/sankofa/blob/main/bin/sankofa-chrome.zip) 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](https://github.com/vectara/sankofa/blob/main/bin/sankofa-firefox.zip) 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](https://github.com/vectara/sankofa/blob/main/bin/sankofa-edge.zip) 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](https://nodejs.org/en/download). That's it!
To install Sankofa from this repository, please follow these steps:
1. **Clone the GitHub Repository**
```bash
git clone https://github.com/vectara/sankofa.git
cd sankofa
```
2. **Install dependencies**
```bash
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.