Awesome
⚡ Sink
A Simple / Speedy / Secure Link Shortener with Analytics, 100% run on Cloudflare.
<a href="https://trendshift.io/repositories/10421" target="_blank"> <img src="https://trendshift.io/api/badge/repositories/10421" alt="ccbikai/Sink | Trendshift" style="width: 250px; height: 55px;" width="250" height="55" /> </a> <a href="https://news.ycombinator.com/item?id=40843683"> <img src="https://hackernews-badge.vercel.app/api?id=40843683" alt="Featured on Hacker News" style="width: 250px; height: 55px;" width="250" height="55" /> </a>
✨ 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.
- 🪄 AI Slug: Leverage AI to generate slugs.
- Link Expiration: Set expiration dates for your links.
🪧 Demo
Experience the demo at Sink.Cool. Log in using the Site Token below:
Site Token: SinkCool
<details>
<summary><b>Screenshots</b></summary>
<img alt="Analytics" src="./docs/images/sink.cool_dashboard.png"/>
<img alt="Links" src="./docs/images/sink.cool_dashboard_links.png"/>
<img alt="Link Analytics" src="./docs/images/sink.cool_dashboard_link_slug.png"/>
</details>
🧱 Technologies Used
- Framework: Nuxt
- Database: Cloudflare Workers KV
- 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
- Raycast Extension - Raycast-Sink
- Apple Shortcuts
- Enhanced Link Management (with Cloudflare D1)
- Analytics Enhancements (Support for merging filter conditions)
- Dashboard Performance Optimization (Infinite loading)
- Units Test
- Support for Other Deployment Platforms
🏗️ Deployment
Video tutorial: Watch here
-
Fork the repository to your GitHub account.
-
Create a project in Cloudflare Pages.
-
Select the
Sink
repository and choose theNuxt.js
preset. -
Configure the following environment variables:
NUXT_SITE_TOKEN
: Must be longer than 8 characters. This token grants access to your dashboard.NUXT_CF_ACCOUNT_ID
: Locate your account ID.NUXT_CF_API_TOKEN
: Create a Cloudflare API token with at leastAccount.Account Analytics
permissions. See reference.
-
Save and deploy the project.
-
Cancel the deployment, then navigate to Settings -> Bindings -> Add:
- KV Namespace: Bind the variable name
KV
to a KV namespace (create a new one under Workers & Pages -> KV). - Workers AI (Optional): Bind the variable name
AI
to the Workers AI Catalog. - Analytics Engine:
- In Workers & Pages, go to Account details on the right side, find
Analytics Engine
, and clickSet up
to enable the free version. - Return to Settings -> Bindings -> Add and select Analytics engine.
- Bind the variable name
ANALYTICS
to thesink
dataset.
- In Workers & Pages, go to Account details on the right side, find
- KV Namespace: Bind the variable name
-
Redeploy the project.