Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zhuzhuyule/sink-extension
Short link extension for sink, also it can generate QRCode for the current tab url.
https://github.com/zhuzhuyule/sink-extension
chrome-extension edge-extension qrcode short-link short-url sink
Last synced: about 2 months ago
JSON representation
Short link extension for sink, also it can generate QRCode for the current tab url.
- Host: GitHub
- URL: https://github.com/zhuzhuyule/sink-extension
- Owner: zhuzhuyule
- License: mit
- Created: 2024-08-18T17:11:23.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-08-21T06:29:43.000Z (6 months ago)
- Last Synced: 2024-10-30T01:44:56.697Z (3 months ago)
- Topics: chrome-extension, edge-extension, qrcode, short-link, short-url, sink
- Language: TypeScript
- Homepage: https://github.com/ccbikai/Sink
- Size: 883 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🔗 Sink Short URL Extension
This is a Chrome extension that allows for quick generation and preview of short links using [Sink](https://github.com/ccbikai/Sink).
### ✨ Features
* Instantly shorten the current webpage URL into a Sink short link.
* Customizable short link suffix.
* Preview shortened links with quick copy functionality.
* Log in to your Sink account to manage generated short links.
### ☀️ Screenshots
* Popup Page
* QRCode Page
* Setting Page
* Setting Page - Login
### 🛠 Development and Debugging
1. Clone the repository to your local machine
```bash
git clone https://github.com/zhuzhuyule/sink-extension.git
```
2. Enter the project directory
```bash
cd sink-extension
```
3. Install dependencies
```bash
pnpm install
```
4. Start the development server
```bash
pnpm dev
# or
pnpm build
```
5. Open Chrome browser and navigate to the Extensions page (chrome://extensions/).
6. Enable Developer mode.
7. Click the `Load unpacked extension` button.
8. Select the root directory of the extension `./sink-tool`.
### 📦 Manual Installation
You can install the extension using the following steps:
1. Download the [sink-tool.zip](https://github.com/zhuzhuyule/sink-extension/releases/) file.
2. Extract the zip file.
3. Open Chrome browser and navigate to the Extensions page (chrome://extensions/).
4. Enable Developer mode.
5. Click the `Load unpacked extension` button.
6. Select the root directory of the extension `sink-tool`.
### 🚀 Usage
1. Install Sink service: refer to [https://github.com/ccbikai/Sink](https://github.com/ccbikai/Sink)
2. Install the extension into the Chrome browser.
3. Navigate to the webpage you want to shorten.
4. Click the extension icon, customize the short link suffix (optional).
5. Click the generate button, preview, and copy the short link.
### 🛠️ Tech Stack
* **Preact:** Lightweight UI library for building user interfaces.
* **TypeScript:** Adds type checking for better readability and maintainability.
* **Vite:** Fast development server and build tool.
* **Tailwind CSS:** Utility-first CSS framework for building modern interfaces.
* **ESLint:** Code style checker to ensure code quality.
* **Prettier:** Code formatter to maintain consistent style.
* **Jest:** JavaScript testing framework for unit and integration tests.
* **Chrome Extension Manifest Version 3:** The latest version of Chrome Extension spec.
### 🤝 Contributing
Feel free to submit issues and pull requests!
### 📄 License
Distributed under the [MIT License](https://github.com/zhuzhuyule/sink-extension/LICENSE).