Skip to content

Commit bd47e75

Browse files
ccbikaiccbikai
committed
feat: init
0 parents  commit bd47e75

File tree

298 files changed

+21915
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

298 files changed

+21915
-0
lines changed

‎.editorconfig

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_size = 2
6+
indent_style = space
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.env.example

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
NUXT_PUBLIC_PREVIEW_MODE=true
2+
NUXT_PUBLIC_SLUG_DEFAULT_LENGTH=5
3+
NUXT_SITE_TOKEN=SinkCool
4+
NUXT_REDIRECT_STATUS_CODE=308
5+
NUXT_HOME_URL="https://sink.cool"
6+
NUXT_CF_ACCOUNT_ID=123456
7+
NUXT_CF_API_TOKEN=CloudflareAPIToken
8+
NUXT_DATASET=sink_v0
9+
NUXT_AI_MODEL="@cf/meta/llama-3-8b-instruct"
10+
NUXT_AI_PROMPT="You are a URL shortening assistant......"

‎.gitignore

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
4+
.nuxt
5+
.nitro
6+
.cache
7+
dist
8+
9+
# Node dependencies
10+
node_modules
11+
12+
# Logs
13+
logs
14+
*.log
15+
16+
# Misc
17+
.DS_Store
18+
.fleet
19+
.idea
20+
21+
# Local env files
22+
.env
23+
.env.*
24+
!.env.example
25+
.wrangler
26+
site
27+
cache

‎.node-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v20

‎.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shamefully-hoist=true

‎.vscode/extensions.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"vue.volar"
4+
]
5+
}

‎.vscode/settings.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
// Enable ESlint flat config support
3+
"eslint.experimental.useFlatConfig": true
4+
}

‎LICENSE

Lines changed: 661 additions & 0 deletions
Large diffs are not rendered by default.

‎README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# ⚡ Sink
2+
3+
**A Simple / Speedy / Secrue Link Shortener with Analytics, 100% run on Cloudflare.**
4+
5+
![Hero](./public/image.png)
6+
7+
----
8+
9+
## ✨ Features
10+
11+
- **URL Shortening:** Compress your URLs to their minimal length.
12+
- **Analytics:** Monitor link analytics and gather insightful statistics.
13+
- **Serverless:** Deploy without the need for traditional servers.
14+
- **Customizable Slug:** Support for personalized slugs.
15+
- **🪄 AI Slug:** Leverage AI to generate slugs.
16+
- **Link Expiration:** Set expiration dates for your links.
17+
18+
## 🪧 Demo
19+
20+
Experience the demo at [Sink.Cool](https://sink.cool/dashboard). Log in using the Site Token below:
21+
22+
```txt
23+
Site Token: SinkCool
24+
```
25+
26+
## 🧱 Technologies Used
27+
28+
- **Framework**: [Nuxt](https://nuxt.com/)
29+
- **Database**: [Cloudflare Workers KV](https://developers.cloudflare.com/kv/)
30+
- **Analytics Engine**: [Cloudflare Workers Analytics Engine](https://developers.cloudflare.com/analytics/)
31+
- **UI Components**: [Shadcn-vue](https://www.shadcn-vue.com/)
32+
- **Styling:** [Tailwind CSS](https://tailwindcss.com/)
33+
- **Deployment**: [Cloudflare](https://www.cloudflare.com/)
34+
35+
## 🚗 Roadmap [WIP]
36+
37+
We welcome your contributions and PRs.
38+
39+
- [ ] Browser Extension
40+
- [ ] Raycast Extension
41+
- [ ] Apple Shortcuts
42+
- [ ] Enhanced Link Management (with Cloudflare D1)
43+
- [ ] Analytics Enhancements (Support for merging filter conditions)
44+
- [ ] Dashboard Performance Optimization (Infinite loading)
45+
- [ ] Units Test
46+
- [ ] Support for Other Deployment Platforms
47+
48+
## 🏗️ Deployment
49+
50+
1. [Fork](https://github.com/ccbikai/Sink/fork) the repository to your GitHub account.
51+
2. Create a [Cloudflare Pages](https://developers.cloudflare.com/pages/) project.
52+
3. Select the `Sink` repository and the `Nuxt.js` preset.
53+
4. Configure environment variables.
54+
1. `NUXT_SITE_TOKEN` length must exceed **8**.
55+
2. `NUXT_CF_ACCOUNT_ID` [find your account ID](https://developers.cloudflare.com/fundamentals/setup/find-account-and-zone-ids/).
56+
3. `NUXT_CF_API_TOKEN` Create a [Cloudflare API token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). This token requires `Account.Account Analytics` permissions at the very least. [Reference.](https://developers.cloudflare.com/analytics/analytics-engine/sql-api/#authentication).
57+
58+
5. Save and deploy.
59+
6. Cancel the deployment, navigate to `Settings` -> `Functions`.
60+
1. KV namespace bindings. Bind the variable name `KV` to a KV namespace.
61+
2. Workers AI Bindings. Bind the variable name `AI` to the Workers AI Catalog. _Optional_
62+
3. Analytics Engine bindings. Bind the variable name `ANALYTICS` to the `sink` dataset, and enable [Cloudflare Analytics Engine beta](https://developers.cloudflare.com/analytics/analytics-engine/get-started/) for your account.
63+
7. Redeploy.
64+
65+
## ⚒️ Configuration
66+
67+
[Configuration Docs](./docs/configuration.md)
68+
69+
## 💖 Credits
70+
71+
1. [**Cloudflare**](https://www.cloudflare.com/)
72+
2. [**NuxtHub**](https://hub.nuxt.com/)
73+
3. [**Astroship**](https://astroship.web3templates.com/)
74+
75+
## ☕ Sponsor
76+
77+
1. [Follow Me on X(Twitter)](https://x.com/ccbikai).
78+
2. [Become a sponsor to on GitHub](https://github.com/sponsors/ccbikai).

‎app.config.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
export default defineAppConfig({
2+
title: 'Sink',
3+
description: 'A Simple / Speedy / Secrue Link Shortener with Analytics, 100% run on Cloudflare.',
4+
image: 'https://sink.cool/banner.png',
5+
previewTTL: 24 * 3600, // 24h
6+
slugRegex: /^[a-z0-9]+(?:-[a-z0-9]+)*$/i,
7+
reserveSlug: [
8+
'dashboard',
9+
],
10+
})

0 commit comments

Comments
 (0)