Awesome
<div align="right">Language: :us: <a title="Chinese" href="doc/cn/README.md">:cn:</a></div> <h1 align="center">🔗 Sink Short URL Extension</h1>This is a Chrome extension that allows for quick generation and preview of short links using 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
- Clone the repository to your local machine
git clone https://github.com/zhuzhuyule/sink-extension.git
- Enter the project directory
cd sink-extension
- Install dependencies
pnpm install
- Start the development server
pnpm dev
# or
pnpm build
- Open Chrome browser and navigate to the Extensions page (chrome://extensions/).
- Enable Developer mode.
- Click the
Load unpacked extensionbutton. - Select the root directory of the extension
./sink-tool.
📦 Manual Installation
You can install the extension using the following steps:
- Download the sink-tool.zip file.
- Extract the zip file.
- Open Chrome browser and navigate to the Extensions page (chrome://extensions/).
- Enable Developer mode.
- Click the
Load unpacked extensionbutton. - Select the root directory of the extension
sink-tool.
🚀 Usage
- Install Sink service: refer to https://github.com/ccbikai/Sink
- Install the extension into the Chrome browser.
- Navigate to the webpage you want to shorten.
- Click the extension icon, customize the short link suffix (optional).
- 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.