https://github.com/ccbikai/Sink
⚡ A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare.
https://github.com/ccbikai/Sink
analytics bitly-alternative cloudflare hacktoberfest link-shortener nuxt nuxthub shadcn-ui tailwindcss url-shortener web-analytics
Last synced: 5 months ago
JSON representation
⚡ A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare.
- Host: GitHub
- URL: https://github.com/ccbikai/Sink
- Owner: ccbikai
- License: agpl-3.0
- Created: 2024-05-05T13:53:54.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-29T13:16:48.000Z (about 1 year ago)
- Last Synced: 2025-01-01T18:56:48.471Z (about 1 year ago)
- Topics: analytics, bitly-alternative, cloudflare, hacktoberfest, link-shortener, nuxt, nuxthub, shadcn-ui, tailwindcss, url-shortener, web-analytics
- Language: Vue
- Homepage: https://Sink.Cool
- Size: 2.89 MB
- Stars: 3,307
- Watchers: 11
- Forks: 1,841
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- StarryDivineSky - ccbikai/Sink
- awesome-cloudflare - Sink
- Awesome-independent-tools - Sink - 一个简单/快速/安全的链接缩短器，带有分析功能，100% 运行在 Cloudflare 上。 (🧰 工具列表 / 部署与托管)
- my-awesome - ccbikai/Sink - alternative,cloudflare,hacktoberfest,link-shortener,nuxt,nuxthub,shadcn-ui,tailwindcss,url-shortener,web-analytics pushed_at:2025-11 star:5.9k fork:3.9k ⚡ A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare. (Vue)
- awesome-cloudflare-applications - Sink
- awesome-repositories - ccbikai/Sink - ⚡ A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare. (Vue)
- starred - ccbikai/Sink - ⚡ A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare. (Vue)
- awesome-shadcnui - Github
README
# ⚡ Sink
**A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare.**
[
](https://deepwiki.com/ccbikai/Sink)
---
## ✨ 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.
## 🪧 Demo
Experience the demo at [Sink.Cool](https://sink.cool/dashboard). Log in using the Site Token below:
```txt
Site Token: SinkCool
```
Screenshots
## 🧱 Technologies Used
- **Framework**: [Nuxt](https://nuxt.com/)
- **Database**: [Cloudflare Workers KV](https://developers.cloudflare.com/kv/)
- **Analytics Engine**: [Cloudflare Workers Analytics Engine](https://developers.cloudflare.com/analytics/)
- **UI Components**: [shadcn-vue](https://www.shadcn-vue.com/)
- **Styling:** [Tailwind CSS](https://tailwindcss.com/)
- **Deployment**: [Cloudflare](https://www.cloudflare.com/)
## 🚗 Roadmap [WIP]
We welcome your contributions and PRs.
- [x] Browser Extension - [Sink Tool](https://github.com/zhuzhuyule/sink-extension)
- [x] Raycast Extension - [Raycast-Sink](https://github.com/foru17/raycast-sink)
- [x] Apple Shortcuts - [Sink Shortcuts](https://s.search1api.com/sink001)
- [x] iOS App - [Sink](https://apps.apple.com/app/id6745417598)
- [ ] Enhanced Link Management (with Cloudflare D1)
- [ ] Analytics Enhancements (Support for merging filter conditions)
- [ ] Dashboard Performance Optimization (Infinite loading)
- [ ] Units Test
## 🏗️ Deployment
> Video tutorial: [Watch here](https://www.youtube.com/watch?v=MkU23U2VE9E)
We currently support deployment to [Cloudflare Workers](./docs/deployment/workers.md) (recommended) and [Cloudflare Pages](./docs/deployment/pages.md).
## ⚒️ Configuration
[Configuration Docs](./docs/configuration.md)
## 🔌 API
[API Docs](./docs/api.md)
## 🧰 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.
```json
{
"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/create"
}
}
}
}
```
## 🙋🏻 FAQs
[FAQs](./docs/faqs.md)
## 💖 Credits
1. [**Cloudflare**](https://www.cloudflare.com/)
2. [**NuxtHub**](https://hub.nuxt.com/)
3. [**Astroship**](https://astroship.web3templates.com/)
## ☕ Sponsor
1. [Follow Me on X(Twitter)](https://404.li/kai).
2. [Become a sponsor to on GitHub](https://github.com/sponsors/ccbikai).