⚡ Sink (Gamas Edition)

---

Note

This is a customized fork of the original Sink project. It has been detached and modified to meet specific personal requirements and enhancements. While this version includes advanced features like D1 integration and UI optimizations, the original credits remain with the initial author. If you are looking for the general version, please visit the original repository. You are free to use this version if its enhancements suit your needs.

---

❤️ Support & Community

This project is developed with dedication to the community. If you find it valuable, consider supporting its maintenance and growth:

---

A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare.

---

✨ Features

• 🔗 URL Shortening: Compress your URLs to their minimal length.
• 📈 Analytics: Monitor link analytics and gather insightful statistics.
• ☁️ Serverless: Deploy without the need for traditional servers.
• 🎨 Customizable Slug: Support for personalized slugs and case sensitivity.
• 🪄 AI Slug: Leverage AI to generate slugs.
• ⏰ Link Expiration: Set expiration dates for your links.
• 📅 Link Scheduling: Set activation windows for your links (starts at).
• 🏷️ Organization: Organize links using Tags and Folders.
• 📱 Device Routing: Redirect iOS/Android users to different URLs (App Store links).
• 🖼️ OpenGraph Preview: Custom social media previews with title, description, and image.
• 📊 Real-time Analytics: Live 3D globe visualization and real-time event logs.
• 🚀 Advanced Management: Instant search, sort, and filter powered by Cloudflare D1.
• 🖥️ Custom View Modes: Toggle between Grid, Minimal, and List views for better link management.
• ✂️ Compact URL Display: Visual option to simplify short link display (e.g., .../slug) while maintaining full functionality.
• 🔲 QR Code: Generate QR codes for your short links.
• 📦 Import/Export: Bulk migration via JSON/CSV files.
• 🌍 Multi-language: Full i18n support for the dashboard.
• 🌙 Dark Mode: Light, dark, and system theme support.

🪧 Demo

Experience the demo at Sink.Cool. Log in using the Site Token below:

Site Token: SinkCool

Screenshots

🧱 Technologies Used

• Framework: Nuxt
• Database (Fast Path): Cloudflare Workers KV
• Database (Management): Cloudflare D1
• Analytics Engine: Cloudflare Workers Analytics Engine
• UI Components: shadcn-vue
• Styling: Tailwind CSS
• Deployment: Cloudflare

🚗 Roadmap [WIP]

We welcome your contributions and PRs.

• Browser Extension - Sink Tool
• Chrome Extension - Sink Quick Shorten
• Raycast Extension - Raycast-Sink
• Apple Shortcuts - Sink Shortcuts
• iOS App - Sink
• Enhanced Link Management (with Cloudflare D1)
• [/] Analytics Enhancements (Support for merging filter conditions)
• Dashboard Performance Optimization (Infinite loading)
• Units Test (Core API covered)

🏗️ Deployment

Video tutorial: Watch here

We currently support deployment to Cloudflare Workers (recommended) and Cloudflare Pages.

⚒️ Configuration

Configuration Docs

🔌 API

API Docs

🤖 AI Skills

Install Sink AI Skills for enhanced coding assistance:

npx skills add miantiao-me/sink

🧰 MCP

We currently do not support native MCP Server, but we have OpenAPI documentation, and you can use the following method to support MCP.

Replace the domain name in OPENAPI_SPEC_URL with your own domain name.

The API_KEY is the same as the NUXT_SITE_TOKEN in the environment variables.

{
  "mcpServers": {
    "sink": {
      "command": "uvx",
      "args": [
        "mcp-openapi-proxy"
      ],
      "env": {
        "OPENAPI_SPEC_URL": "https://sink.cool/_docs/openapi.json",
        "API_KEY": "SinkCool",
        "TOOL_WHITELIST": "/api/link"
      }
    }
  }
}

🙋🏻 FAQs

FAQs

💖 Credits

1. Original Project - miantiao-me
2. Cloudflare
3. NuxtHub
4. Astroship
5. Tailark