diff --git a/README.md b/README.md index 50dc29b..7c3fc84 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,61 @@ -# cf-drop +

+

cf-drop

+

🗃️ Private File/Text Box — Deploy on Cloudflare Workers

-A fast and simple tool to store and share temporary files via Cloudflare Workers. + + + + + + +
+ + +
    +
  • ⚡ Serverless on Cloudflare Worker
  • +
  • 📱 PWA ready! for mobile
  • +
  • 🔑 Password protected
  • +
  • 📦 Download as Tarball
  • +
  • 🚚 Resumable download link
  • +
  • 🔗 Shareable download link
  • +
+
+ +## 🚀 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! 🚀 diff --git a/image.png b/image.png new file mode 100644 index 0000000..5e13443 Binary files /dev/null and b/image.png differ diff --git a/package.json b/package.json index a2f23cd..38b2f09 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,7 @@ "engines": { "node": ">=20" }, + "packageManager": "pnpm@9.15.4+sha512.b2dc20e2fc72b3e18848459b37359a32064663e5627a51e4c74b2c29dd8e8e0491483c3abb40789cfd578bf362fb6ba8261b05f0387d76792ed6e23ea3b1b6a0", "dependencies": { "hono": "^4.6.15" }, @@ -20,4 +21,4 @@ "npm-run-all": "^4.1.5", "wrangler": "^3.96.0" } -} \ No newline at end of file +}