Use Lateral to recommend content that is relevant to the page you're currently seeing in Chrome
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.bundle
src
.editorconfig
.gitattributes
.gitignore
.jscsrc
.scss-lint.yml
LICENSE.txt
README.md
give-me-five.crx
gulpfile.js
package.json

README.md

Give me five

This allows you to create notifications that recommend your content that is relevant to the page you're currently seeing in Chrome. Example of configuring the extension and getting recommendations:

Example of configuring the extension and getting recommendations

Overview

First you'll need to add content. You'll need an API key which you can then add content to, see our documentation for information about how to do that. Once you have that, you can either hard-code your key into the extension and recompile or you can use our precompiled extension that allows you to add a key through the extension itself.

Installing

Download the extension here. Visit chrome://extensions/ and drag the downloaded give-me-five.crx file to the window and drop it to install.

Configuration

If you're using the version of the extension available from this repository then you will need to add your Subscription Key in order to get recommendations. Click the extension icon (a blue Lateral logo towards the top right of your Chrome browser window) to open the extension window. Click 'Settings' to enter the settings menu. Enter your subscription key where it says 'key' and then click 'Save'.

Get recommendations

Firstly visit the web page you want to get recommendations for in Chrome. Now click the extension icon that sits towards the top right of the Chrome browser window. From here click 'Give me 5' to get recommendations. Alternatively, you can use the keyboard shortcut which is Command (or Ctrl) + Shift + 9. The first time it will ask for extended permissions.

Customisation

The purpose of open-sourcing this extension is so that you can easily create your own version of the extension.

Development

The main code that powers the extension is under the src folder. The javascript and scss are processed as you work by gulp so ensure that gulp is running by running:

gulp 

From the give-me-five directory. This will automatically process all files into the extension folder. During development you may find it easiest to drag the entire extension directory into the chrome://extensions/ page. This means that you won't need to recompile the extension after every change.

To 'bake' your own key in to the extension

If you don't want to have the ability to set the subscription key from within the extension then you can hard-code the key to the extension. Note: please be careful to use a read-only key here otherwise people could potentially delete your data. To set the key, edit the src/scripts/config.js file and change the line:

key: null,

to:

key: 'your_key_goes_here',

Now you will need to re-compile the .crx and install the extension.

To create a .crx

To compile a .crx for adding to Chrome you can run:

gulp release --release