chore: readme

This commit is contained in:
lyonbot committed 2025-01-21 20:15:24 +08:00
1 parent 922759bdb4
commit b8de47a9b0
3 files changed
+49 -8

No files matched your search

+48 -8
View File
@@ -1,21 +1,61 @@
# cf-drop
<p align="center"><img src="./web/public/icon.svg" width="64"></p>
<h1 align="center">cf-drop</h1>
<p align="center">🗃️ Private File/Text Box — Deploy on Cloudflare Workers</p>
A fast and simple tool to store and share temporary files via Cloudflare Workers.
<table width="100%">
<tr>
<td>
<img src="./image.png" width="200">
</td>
<td>
<ul>
<li>⚡ <strong>Serverless</strong> on Cloudflare Worker</li>
<li>📱 <strong>PWA ready!</strong> for mobile</li>
<li>🔑 <strong>Password protected</strong></li>
<li>📦 <strong>Download</strong> as Tarball</li>
<li>🚚 <strong>Resumable download link</strong></li>
<li>🔗 <strong>Shareable download link</strong></li>
</ul>
</td>
</tr>
</table>
## 🚀 Quick Start
Follow these steps to get up and running quickly:
```sh
# Prerequisites: Node.js >= 20, pnpm
# Install dependencies
pnpm install
# Create R2 bucket
npx wrangler r2 bucket create cf-drop
# Create D1 database
npx wrangler d1 create cf-drop
# copy the database_id to wrangler.toml
# -- or find it from Cloudflare Dashboard - D1 SQL page
# ... copy the database_id to wrangler.toml
# Deploy the application
npm run deploy
# npm run dev # -- for local development
# For local development
# npm run dev
```
You can access the app on mobile, and install it as a PWA.
You can access the app on mobile and install it as a Progressive Web App (PWA).
## Customize
## 🎨 Customize
- Change theme color in `./web/public/manifest.json`
Make `cf-drop` your own by customizing the following:
- 🔑 **Set password** via `./wrangler.toml`
- 🎨 **Change theme color** in `./web/public/manifest.json`
- 💡 **Find `database_id`** from Cloudflare Dashboard - D1 SQL page
---
Happy deploying! 🚀
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB

+1
View File
@@ -12,6 +12,7 @@
"engines": {
"node": ">=20"
},
"packageManager": "pnpm@9.15.4+sha512.b2dc20e2fc72b3e18848459b37359a32064663e5627a51e4c74b2c29dd8e8e0491483c3abb40789cfd578bf362fb6ba8261b05f0387d76792ed6e23ea3b1b6a0",
"dependencies": {
"hono": "^4.6.15"
},