mirror of
https://github.com/thedevs-network/kutt-extension.git
synced 2026-02-03 05:43:24 +00:00
57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
## Contributing Guidelines
|
||
|
||
## Assets
|
||
|
||
- [kutt.it API](https://github.com/thedevs-network/kutt#api) is used to retreive shortened URLs.
|
||
|
||
## Development
|
||
|
||
- `npm install` to install dependencies.
|
||
- To watch file changes in developement
|
||
|
||
- Chrome
|
||
- `npm run dev:chrome`
|
||
- Firefox
|
||
- `npm run dev:firefox`
|
||
|
||
(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.
|
||
|
||
<img width="400" src="https://i.imgur.com/dJRL7By.png" />
|
||
|
||
- ### Firefox
|
||
|
||
- Load the Add-on via `about:debugging` as temporary Add-on.
|
||
- Choose the `manifest.json` file in the extracted directory
|
||
|
||
<img width="400" src="https://i.imgur.com/aAL5dQg.png" />
|
||
|
||
- Generate an API Key from <a href="https://kutt.it">`https://kutt.it/`</a> (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`
|
||
|
||
[<img src=".github/assets/direct-download.png"
|
||
alt="Direct download"
|
||
height="50">](https://github.com/thedevs-network/kutt-extension/releases)
|
||
|
||
<hr />
|
||
|
||
## Self-hosted Kutt
|
||
|
||
- **Enable Developer Options** to use with self-hosted kutt
|
||
- Save the self hosted domain in the input (eg: https://mykutt.it)
|
||
- **Note**: the api endpoint is automatically appended during the api call.
|