kutt-extension - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #golang #rust #docker #macos #nodejs #java #windows #cli #security #mcp #openai

kutt-extension

(★ 150)

🔗✂️ Cross-Browser URL Shortener Extension based on Kutt.it

파일 탐색기

최종 버전 다운로드 (.zip)

- - direct-download.png
  - options-v4-1.png
  - popup-v4-1.png
- - issue-template.md
- - build.yml
- FUNDING.yml
- - constants.ts
  - index.ts
- - BodyWrapper.module.scss
  - BodyWrapper.tsx
  - Loader.module.scss
  - Loader.tsx
- - extension-settings-context.tsx
  - request-status-context.tsx
  - shortened-links-context.tsx
- - history.html
  - History.module.scss
  - History.tsx
  - index.tsx
  - Modal.module.scss
  - Modal.tsx
  - styles.scss
  - Table.module.scss
  - Table.tsx
- - Footer.module.scss
  - Footer.tsx
  - Form.module.scss
  - Form.tsx
  - Header.module.scss
  - Header.tsx
  - index.tsx
  - options.html
  - Options.module.scss
  - Options.tsx
- - Form.module.scss
  - Form.tsx
  - Header.module.scss
  - Header.tsx
  - index.tsx
  - popup.html
  - Popup.module.scss
  - Popup.tsx
  - ResponseBody.module.scss
  - ResponseBody.tsx
- - _components.scss
  - _reset.scss
  - _variables.scss
  - main.scss
- - browser.ts
  - link.ts
  - messageUtil.ts
  - settings.ts
  - tabs.ts
- globals.d.ts
- manifest.json
.gitignore
.nvmrc
CODE_OF_CONDUCT.md
CONTRIBUTING.md
eslint.config.mjs
license
package-lock.json
package.json
postcss.config.js
README.md
tsconfig.json
vite.config.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/thedevs-network/kutt-extension

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd kutt-extension

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm run dev:chrome # For Chrome

개발/실행 서버를 켭니다.

npm run dev:firefox # For Firefox

개발/실행 서버를 켭니다.

npm run build:chrome # Build Chrome extension

배포용으로 코드를 최적화해서 빌드 파일을 생성합니다.

npm run build:firefox # Build Firefox addon

배포용으로 코드를 최적화해서 빌드 파일을 생성합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center"><img width="150" src="source/public/assets/logo.png" /></div>
<h1 align="center">kutt-extension</h1>
<p align="center">Browser extension for <a href="https://kutt.it">Kutt.it</a> URL shortener</p>
<div align="center">
  <a href="https://github.com/thedevs-network/kutt-extension/actions/workflows/build.yml">
    <img src="https://github.com/thedevs-network/kutt-extension/actions/workflows/build.yml/badge.svg?branch=master" alt="Build" />
  </a>
  <a href="https://github.com/thedevs-network/kutt-extension/releases/latest">
    <img src="https://img.shields.io/github/release/thedevs-network/kutt-extension.svg?colorB=blue" alt="Releases" />
  </a>
  <a href="https://github.com/thedevs-network/kutt-extension/issues?q=is%3Aopen+is%3Aissue">
    <img src="https://img.shields.io/github/issues-raw/thedevs-network/kutt-extension.svg?colorB=lightgrey" alt="Open Issues" />
  </a>
  <a href="https://github.com/thedevs-network/kutt-extension/issues?q=is%3Aissue+is%3Aclosed">
    <img src="https://img.shields.io/github/issues-closed-raw/thedevs-network/kutt-extension.svg?colorB=red" alt="Closed Issues" />
  </a>
  <a href="https://github.com/thedevs-network/kutt-extension/blob/master/license">
    <img src="https://img.shields.io/github/license/thedevs-network/kutt-extension.svg" alt="LICENSE" />
  </a>
</div>
<hr />

❤️ it? ⭐️ it on [GitHub](https://github.com/thedevs-network/kutt-extension/stargazers)

## Features

- Minimal UI
- Instant QR Code
- Cross Browser Support
- Supports Secure Passwords for URLs
- History & Incognito Feature
- Auto Copy Feature
- Free and Open Source
- Uses WebExtensions API

## Tech Stack

- **Bundler**: [Vite](https://vitejs.dev/) 6
- **UI**: [React](https://react.dev/) 19
- **Language**: [TypeScript](https://www.typescriptlang.org/) 5.7
- **Styling**: SCSS with CSS Modules
- **Linting**: ESLint 9 (flat config) + Prettier

## Browser Support

This extension uses **Manifest V3**.

| [![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](https://addons.mozilla.org/firefox/addon/kutt/) | [![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Brave](https://raw.github.com/alrra/browser-logos/master/src/brave/brave_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 88+                                                                                                                                                                         | 109+                                                                                                                                          | 74+                                                                                                                                                                      | 88+                                                                                                                                                                         | 1.21+                                                                                                                                                                    |

## Installation

- **Chrome**: [Kutt :: Chrome Web Store](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd)
- **Firefox**: [Kutt :: Add-ons for Firefox](https://addons.mozilla.org/firefox/addon/kutt/)
- **Edge**: [Kutt :: Chrome Web Store](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd)

## How to Use

1. Generate an API Key from <a href="https://kutt.it">`https://kutt.it/`</a> after signing up (Settings page)

<img width="400" src="https://i.imgur.com/qQwqeH5.png" />

2. Paste and Save this `Key` in extension's `options page` when asked

## Screenshots

<div>
  <img width="250" src="./.github/assets/popup-v4-1.png" alt="popup" />
  <div>_</div>
  <img width="330" src="./.github/assets/options-v4-1.png" alt="options" />
</div>

## Development

Ensure you have [Node.js](https://nodejs.org) 20 or later installed.

```bash
# Install dependencies
npm install

# Start development server
npm run dev:chrome    # For Chrome
npm run dev:firefox   # For Firefox

# Build for production
npm run build:chrome  # Build Chrome extension
npm run build:firefox # Build Firefox addon
npm run build         # Build for all browsers

# Linting
npm run lint          # Run ESLint
npm run lint:fix      # Run ESLint with auto-fix
```

### Loading the Extension

#### Chrome

1. Navigate to `chrome://extensions`
2. Enable "Developer mode"
3. Click "Load unpacked"
4. Select `extension/chrome` directory

#### Firefox

1. Navigate to `about:debugging`
2. Click "This Firefox"
3. Click "Load Temporary Add-on"
4. Select `extension/firefox/manifest.json`

## Note

- <a href="https://kutt.it">Kutt.it</a> API permits **50** URLs shortening per day using the API Key
- **Enable Custom Host** option 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
- _Delay at times while shortening might be the issue with Kutt.it API and not with the extension's_

## Contributing and Support

View the Contributing guidelines [here](CONTRIBUTING.md).

Original Repo: [thedevs-network/kutt](https://github.com/thedevs-network/kutt)

## License

Code released under the [MIT License](license).