Skip to content

Latest commit

 

History

History
87 lines (66 loc) · 2.77 KB

Contributing.md

File metadata and controls

87 lines (66 loc) · 2.77 KB
Raw

Translations

You can help to translate the extension in Weblate. If you want to add a new language, please file an issue to add it to Weblate.

Development requirements

A running Nextcloud instance with the passwords app installed. You can find instructions to set up a test server in the main project Firefox and Chromium are required. Using a test account is recommended A test server can be found here.

Building from source

Project Setup
  1. Run git submodule sync --recursive from the command line
  2. Run git submodule update --init --recursive from the command line
  3. Run npm install from the command line
For Firefox
  1. Run npm run build:firefox
  2. Open "about:debugging" in Firefox
  3. Click "Load Temporary Add-on"
  4. Select the manifest.json in the "dist" folder in the file popup.
For Chromium
  1. Run npm run build:chrome
  2. Open "chrome://extensions/" in Chromium
  3. Enable "Developer Mode"
  4. Click "Load unpacked extension"
  5. Select the "dist" folder in the file popup

Installing from source

Project Setup
  1. Run npm install from the command line
For Firefox
  1. Run npm run watch:firefox
  2. Open "about:debugging" in Firefox
  3. Click "Load Temporary Add-on"
  4. Select the manifest.json in the "dist" folder in the file popup.
For Chromium
  1. Run npm run watch:chrome
  2. Open "chrome://extensions/" in Chromium
  3. Enable "Developer Mode"
  4. Click "Load unpacked extension"
  5. Select the "dist" folder in the file popup

Debugging

In Firefox
  1. Open "about:debugging"
  2. Enable "Activate debugging of extensions"
  3. Scroll to "Passwords for Nextcloud Client" and click on "Debug"
  4. Confirm the debugging request
In Chromium
  1. Open "chrome://extensions/"
  2. Scroll to "Passwords for Nextcloud Client" and click on "Background Page" or "Errors"

Packing

Build on Firefox
  1. Run npm build:firefox
  2. Pack the contents of the "dist" folder to a .zip file
  3. Rename the file to "[email protected]"
Build on Chromium
  1. Run npm build:chrome
  2. Open "chrome://extensions/" in Chromium
  3. Enable "Developer mode"
  4. Click "Pack extension"
  5. Select the "dist" folder in the file popup
  6. If you have a private key file, select it as well
  7. Click on "Pack extension"

Debug API/Connection issues

  1. Follow the steps in Debugging for your browser
  2. Execute the synchronisation action in the extension interface
  3. Network activity should appear in the "Network" tab
  4. Failed requests should be logged in the "Console"