GhostText/contributing.md
2021-02-15 19:35:46 -06:00

1.1 KiB

Contributing

Requirements

Node.js version 15 or later is required.

Workflow

First clone:

git clone https://github.com/fregante/GhostText
cd GhostText
npm install

When working on the extension or checking out branches, use this to have it constantly build your changes:

npm run watch # Listen to file changes and automatically rebuild

Then load or reload it into the browser to see the changes.

Loading into the browser

The built extension will be in the distribution folder.

Or use web-ext to load it automatically and watch for updates:

npm install -g web-ext
npx web-ext run --target=chromium # For Chrome
npx web-ext run # For Firefox