kutt-extension/CONTRIBUTING.md

Contributing Guidelines

Assets

• kutt.it API is used to retreive shortened URLs.
• node-kutt is used for API calls

Development

• npm install to install dependencies.

• To watch file changes in developement

  • Chrome
    • npm run dev-chrome
  • Firefox
    • npm run dev-firefox
  • Opera
    • npm run dev-opera

  (Reload Extension Manually in the browser)

• Load extension in browser

  • Chrome

    • Go to the browser address bar and type chrome://extensions

    • Check the Developer Mode button to enable it.

    • Click on the Load Unpacked Extension… button.

    • Select your extension’s extracted directory.

      

  • Firefox

    • Load the Add-on via about:debugging as temporary Add-on.

    • Choose the manifest.json file in the extracted directory

      

  • Opera

    • Load the extension via opera:extensions

    • Check the Developer Mode and load as unpacked from extension’s extracted directory.

      

• Generate an API Key from https://kutt.it/ (Settings page)

• Paste and Save the Key in extension's options page.

npm run build builds the extension for all the browsers to extension/(browser) directory respectively.

Testing

Download latest Release

ToDo

• Switch to Promise return Method
• Using Node-Kutt package
• History Feature
• Auto Copy Clipboard
• Toggleable Options
• Context Menu
• Keyboard Shortcut

Note:

Shortening might take a while, it's not the issue with the extension but with Kutt.it's API.

For Opera Users

In order to install this extension from Chrome Web Store, another opera extension called Install Chrome Extension should be installed first.

• Opera addon :: Install Chrome Extension
• Opera addon :: Kutt