No description

Find a file

wudi 7cadbfe2b1 refactor: Migrate project files and directories to the app directory using the new compatibilityVersion: 4 feature - Moved `app.config.ts` to the `app` directory - Migrated `.vue` files and other assets to the `app` directory - Updated import paths to reflect the new file locations		2025-03-24 11:05:59 +08:00
.github	chore: Update package dependencies and optimize imports	2024-07-08 20:28:38 +08:00
.vscode	feat: Add internationalization (i18n) support	2025-03-03 11:21:39 +08:00
app	refactor: Migrate project files and directories to the app directory using the new compatibilityVersion: 4 feature	2025-03-24 11:05:59 +08:00
docs	feat: add bot traffic filtering for access logs	2025-03-16 12:57:05 +08:00
i18n	fix: corrects sorting order and enhances link sorting UX	2025-03-16 13:57:29 +08:00
public	feat: consolidate time filtering and add advanced filters	2025-03-02 13:40:43 +08:00
schemas	feat: consolidate time filtering and add advanced filters	2025-03-02 13:40:43 +08:00
scripts	chore: Update package dependencies and optimize imports	2024-07-08 20:28:38 +08:00
server	refactor: Migrate project files and directories to the app directory using the new compatibilityVersion: 4 feature	2025-03-24 11:05:59 +08:00
.editorconfig	feat: init	2024-05-25 08:09:30 +08:00
.env.example	feat: disable query string redirection by default	2024-07-20 18:34:49 +08:00
.gitignore	perf: The map is not packaged into the code to reduce the server size	2024-06-08 17:15:25 +08:00
.node-version	fix: standardize .node-version format	2024-11-04 10:31:31 -06:00
.npmrc	feat: init	2024-05-25 08:09:30 +08:00
CODE_OF_CONDUCT.md	feat: add Contributor Covenant Code of Conduct	2024-10-18 12:04:06 +08:00
components.json	feat: init	2024-05-25 08:09:30 +08:00
eslint.config.mjs	refactor: Migrate project files and directories to the app directory using the new compatibilityVersion: 4 feature	2025-03-24 11:05:59 +08:00
LICENSE	feat: init	2024-05-25 08:09:30 +08:00
nuxt.config.ts	refactor: Migrate project files and directories to the app directory using the new compatibilityVersion: 4 feature	2025-03-24 11:05:59 +08:00
package.json	chore: 0.1.10	2025-03-18 22:09:02 +08:00
pnpm-lock.yaml	feat: add bot traffic filtering for access logs	2025-03-16 12:57:05 +08:00
README.md	docs: update KV Namespace setting path & add docs URL	2025-01-20 14:21:36 +05:30
renovate.json	feat: init	2024-05-25 08:09:30 +08:00
tailwind.config.js	fix: some style issues	2024-06-02 19:18:22 +08:00
tsconfig.json	feat: init	2024-05-25 08:09:30 +08:00
wrangler.toml	feat: init	2024-05-25 08:09:30 +08:00

README.md

⚡ Sink

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.

🪧 Demo

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

Site Token: SinkCool

Screenshots

🧱 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 - Sink 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 the Nuxt.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 least Account.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 Storage & Databases -> 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 click Set up to enable the free version.
  - Return to Settings -> Bindings -> Add and select Analytics engine.
  - Bind the variable name ANALYTICS to the sink dataset.
Redeploy the project.
Update code, refer to the official GitHub documentation Syncing a fork branch from the web UI.