Skip to content

Development

Tim Weißenfels edited this page Feb 6, 2020 · 10 revisions

If you want to participate in the development of Tabs Aside or create your own version or just build Tabs Aside from the source code please follow these instructions:

Requirements

Tabs Aside is written in TypeScript and therefore requires a build step. To build Tabs Aside, Node.js >=10 has to be installed on your machine.

If you have not done this already clone the repository:

> git clone [email protected]:tim-we/tabs-aside.git

Install dependencies

Assuming you are in the Tabs Aside root directory (where package.json is located):

> npm install

Build

> npm run build

This will populate the dist folder with all the files required for the extension to work.

Run the extension in Firefox

It is recommended not use your main Firefox profile for development. Instead you could use Firefox Developer Edition or another profile (go to about:profiles).

Go to about:debugging > This Firefox and click Load Temporary Add-on and select dist/manifest.json.

Development

Run npm run dev to automatically rebuild the parts you change. If you change scripts that are part of the background page/script or the locales press Reload in the about:debugging tab.

Pack the extension

To pack the extension into a single file that could be submitted to the addon store run:

> npm run firefox

This will create a tabs_aside_-{version}.zip file in the releases/ folder.