mirror of
https://github.com/aliasvault/aliasvault.git
synced 2026-01-31 17:32:29 -05:00
86 lines
2.7 KiB
Markdown
86 lines
2.7 KiB
Markdown
---
|
|
layout: default
|
|
title: Browser Extensions
|
|
parent: Development
|
|
grand_parent: Miscellaneous
|
|
nav_order: 2
|
|
---
|
|
|
|
# Browser Extensions
|
|
AliasVault offers browser extensions compatible with both Chrome and Firefox. This guide explains how to build and debug the extensions locally.
|
|
|
|
## Development Setup
|
|
The browser extensions are built using:
|
|
- React: https://react.dev/
|
|
- WXT: https://wxt.dev/ (A framework for cross-browser extension development)
|
|
- Vite: https://vitejs.dev/
|
|
|
|
### Install dependencies
|
|
Make sure you have Node.js installed on your host machine, then install the dependencies:
|
|
|
|
```bash
|
|
cd browser-extensions/chrome
|
|
npm install
|
|
```
|
|
|
|
### Development Mode
|
|
WXT provides a development mode that automatically reloads changes and opens a new browser window with the extension loaded:
|
|
|
|
```bash
|
|
# For Chrome development
|
|
npm run dev:chrome
|
|
|
|
# For Firefox development
|
|
npm run dev:firefox
|
|
```
|
|
|
|
## Building and Loading the Extensions Manually
|
|
|
|
### Chrome
|
|
|
|
1. Build the extension:
|
|
```bash
|
|
npm run build:chrome
|
|
```
|
|
|
|
2. Load in Chrome:
|
|
- Open Chrome and navigate to `chrome://extensions/`
|
|
- Enable "Developer mode" in the top right corner
|
|
- Click "Load unpacked" and the folder `./browser-extension/dist/chrome-mv3`
|
|
|
|
### Firefox
|
|
|
|
1. Build the extension:
|
|
```bash
|
|
npm run build:firefox
|
|
```
|
|
|
|
2. Load in Firefox:
|
|
- Open Firefox and navigate to `about:debugging`
|
|
- Click "This Firefox" in the left sidebar
|
|
- Click "Load Temporary Add-on"
|
|
- Navigate to the `./browser-extension/dist/firefox-mv2` folder and select the `manifest.json` file
|
|
|
|
## Automatic tests
|
|
The extension has a suite of automatic tests that are run on every pull request. These tests are located in the `__tests__` directories scattered throughout the browser extension codebase.
|
|
|
|
### Run the tests
|
|
To run the tests locally, you can use the `npm run test` command. This will run all tests.
|
|
|
|
```bash
|
|
npm run test
|
|
```
|
|
|
|
## Manual tests
|
|
In order to test for client side issues, here is a list of public websites that have caused issues in the past and can be used to test whether the extension is (still) working correctly.
|
|
|
|
### Websites that have caused issues
|
|
The following websites have been known to cause issues in the past (but should be fixed now). After making changes to the extension, you can test whether the extension is (still) working correctly by using the websites below.
|
|
|
|
| Website | Reason |
|
|
| --- | --- |
|
|
| https://www.paprika-shopping.nl/nieuwsbrief/newsletter-register-landing.html | Popup CSS style conflicts |
|
|
| https://bloshing.com/inschrijven-nieuwsbrief | Popup CSS style conflicts |
|
|
| https://gamefaqs.gamespot.com/user | Popup buttons not working |
|
|
| https://news.ycombinator.com/login?goto=news | Popup and client favicon not showing due to SVG format |
|