Add r2-explorer template (#572)

Co-authored-by: James Delorey <jdelorey@cloudflare.com>
Co-authored-by: spersad <spersad@cloudflare.com>
Co-authored-by: Shaun Persad <shaunpersad@gmail.com>

Author: 4 people

pnpm-lock.yaml

@@ -0,0 +1,183 @@
+# Created by https://www.toptal.com/developers/gitignore/api/node,macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=node,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Moved from ./templates for ignoring all locks in templates
+templates/**/*-lock.*
+templates/**/*.lock
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+# End of https://www.toptal.com/developers/gitignore/api/node,macos
+
+# Wrangler output
+.wrangler/
+build/
+
+# Turbo output
+.turbo/

r2-explorer-template/.gitignore

@@ -0,0 +1,79 @@
+# R2-Explorer App
+
+[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/cloudflare/templates/tree/main/r2-explorer-template)
+
+![R2 Explorer Template Preview](https://imagedelivery.net/wSMYJvS3Xw-n339CbDyDIA/e3c4ab7e-43f2-49df-6317-437f4ae8ce00/public)
+
+<!-- dash-content-start -->
+
+R2-Explorer brings a familiar Google Drive-like interface to your Cloudflare R2 storage buckets, making file management simple and intuitive.
+
+## Key Features
+
+- **🔒 Security**
+
+  - Basic Authentication support
+  - Cloudflare Access integration
+  - Self-hosted on your Cloudflare account
+
+- **📁 File Management**
+
+  - Drag-and-drop file upload
+  - Folder creation and organization
+  - Multi-part upload for large files
+  - Right-click context menu for advanced options
+  - HTTP/Custom metadata editing
+
+- **👀 File Handling**
+
+  - In-browser file preview
+    - PDF documents
+    - Images
+    - Text files
+    - Markdown
+    - CSV
+    - Logpush files
+  - In-browser file editing
+  - Folder upload support
+
+- **📧 Email Integration**
+  - Receive and process emails via Cloudflare Email Routing
+  - View email attachments directly in the interface
+
+<!-- dash-content-end -->
+
+> [!IMPORTANT]
+> When using C3 to create this project, select "no" when it asks if you want to deploy. You need to follow this project's [setup steps](https://github.com/cloudflare/templates/tree/main/r2-explorer-template#setup-steps) before deploying.
+
+## Getting Started
+
+Outside of this repo, you can start a new project with this template using [C3](https://developers.cloudflare.com/pages/get-started/c3/) (the `create-cloudflare` CLI):
+
+```
+npm create cloudflare@latest -- --template=cloudflare/templates/r2-explorer-template
+```
+
+A live public deployment of this template is available at [https://demo.r2explorer.com](https://demo.r2explorer.com)
+
+## Setup Steps
+
+1. Install the project dependencies with a package manager of your choice:
+   ```bash
+   npm install
+   ```
+2. Create a [R2 Bucket](https://developers.cloudflare.com/r2/get-started/) with the name "r2-explorer-bucket":
+   ```bash
+   npx wrangler r2 bucket create r2-explorer-bucket
+   ```
+3. Deploy the project!
+   ```bash
+   npx wrangler deploy
+   ```
+
+## Next steps
+
+By default this template is **readonly**.
+
+in order for you to enable editing, just update the `readonly` flag in your `src/index.ts` file.
+
+Its highly recommended that you setup security first, [learn more here](https://r2explorer.com/getting-started/security/).