README.md

Tipsy

Developing

If you wish to work on Tipsy, you can find instructions on getting started below. It uses Node to install and run the extension.

At the moment the build process and tests only work in Linux.

Installing Node and dependencies

Go to the Node homepage and install for your platform.

Next, open a command line prompt and enter the project directory. You will install all development dependencies with one command:

npm install

Working on Chrome extension

To build the Chrome extension, you will need Google Chrome installed.

Once it is installed and configured you can build the extension with:

npm run build-chrome

Loading the unpacked extension

The source code necessary to run the extension as unpacked lives in the dist/tipsy directory and can be dragged into the Extensions tab within Chrome.

Watching the filesystem for changes

You can have the extension automatically recompiled with:

npm run watch-chrome

Extension url

chrome-extension://ajcjbhihdfmefgbenbkpgalkjglcbmmp/html/index.html

Watching the filesystem for changes

You can have both extensions automatically recompiled with:

npm run watch