r2-explorer 0.2.5 → 0.2.6

package/README.md

@@ -0,0 +1,115 @@
+# R2-Explorer
+
+A Google Drive Interface for your Cloudflare R2 Buckets!
+
+This project is deployed/self-hosted in your own Cloudflare Account as a Worker, and no credential/token is required to start using it.
+
+You can see an live example, in `read-only` mode, in your browser at https://r2-explorer.massadas.com/
+
+## Features
+
+- Very quick bucket/folder navigation
+- pdf, image, txt, markdown, etc in-browser preview
+- Drag-and-Drop upload
+- Create folders
+- Rename files
+- Download files
+- Delete files
+- Right click in file for extra options
+
+
+## FAQ
+
+Q. Is there any Authentication for r2-explorer?
+
+A. No. If you want authenticated access, you must setup [Cloudflare Access](https://www.cloudflare.com/products/zero-trust/access/) in your account.
+Access is free up to 50 users.
+
+
+## Getting Started
+
+Run this command to get an example project setup
+
+```bash
+npx r2-explorer my-r2-explorer
+```
+
+Change into the newly created directory and install the packages
+
+```bash
+cd my-r2-explorer
+npm install
+```
+
+Update the `wrangler.toml` with your R2 Buckets (tip: you can setup as many Buckets as your want)
+
+```
+- wrangler.toml -
+...
+[[r2_buckets]]
+binding = 'my-bucket-name'
+bucket_name = 'my-bucket-name'
+preview_bucket_name = 'my-bucket-name'
+```
+
+If you want to be able to upload/modify your buckets, you must update the `readonly` flag in `src/index.ts` file.
+
+After that just run publish and the project will be up and running for you and everyone you invite to use the Buckets
+
+```bash
+wrangler publish
+```
+
+## TODO
+
+- Integration with cloudflare access
+- allow bucket names with spaces
+- Search files
+- CSV Previewer
+- Upload folders
+- Rename folders
+- Delete folders
+- Image thumbnail's using Cloudflare workers
+- Tooltip when hovering a file with absolute time in "x days time ago" format
+- Upload folders with files
+- Automatically load more files, when the bottom is reached (current limit is 1000 files)
+- Download files bigger than 2gb with presigned url's
+
+## Known issues
+
+- Rename files with special characters is not possible with current [sdk issue here](https://github.com/aws/aws-sdk-js/issues/1949)
+
+## Images
+
+Home Page
+![Home](https://github.com/G4brym/R2-Explorer/raw/master/docs/images/home.png)
+
+Image Previewer
+![Home](https://github.com/G4brym/R2-Explorer/raw/master/docs/images/image-preview.png)
+
+Pdf Previewer
+![Home](https://github.com/G4brym/R2-Explorer/raw/master/docs/images/pdf-preview.png)
+
+New Folder
+![Home](https://github.com/G4brym/R2-Explorer/raw/master/docs/images/new-folder.png)
+
+Uploading Files
+![Home](https://github.com/G4brym/R2-Explorer/raw/master/docs/images/uploading-files.png)
+
+### Compiles and hot-reloads for development
+
+```
+npm run serve
+```
+
+### Compiles and minifies for production
+
+```
+npm run build
+```
+
+### Lints and fixes files
+
+```
+npm run lint
+```

package/bin/r2-explorer.js

@@ -0,0 +1,70 @@
+#! /usr/bin/env node
+var fs = require('fs')
+
+const args = process.argv.slice(2)
+const projectName = args[0] || 'r2-explorer'
+
+const dir = `./${projectName}`
+if (!fs.existsSync(dir)) {
+  fs.mkdirSync(dir)
+}
+
+fs.writeFileSync(
+  `${dir}/wrangler.toml`,
+  `name = "${projectName}"
+compatibility_date = "2022-08-09"
+main = "src/index.js"
+
+[[r2_buckets]]
+binding = 'my-bucket-name'
+bucket_name = 'my-bucket-name'
+preview_bucket_name = 'my-bucket-name'
+`
+)
+fs.writeFileSync(
+  `${dir}/package.json`,
+  `{
+  "name": "${projectName}",
+  "version": "0.0.1",
+  "private": true,
+  "devDependencies": {
+    "wrangler": "^2.4.2"
+  },
+  "scripts": {
+    "publish": "wrangler publish"
+  },
+  "dependencies": {
+    "r2-explorer": "^0.2.6"
+  }
+}
+
+`
+)
+
+const srcDir = `${dir}/src`
+if (!fs.existsSync(srcDir)) {
+  fs.mkdirSync(srcDir)
+}
+
+fs.writeFileSync(
+  `${srcDir}/index.js`,
+  `import { R2Explorer } from 'r2-explorer';
+
+const explorer = R2Explorer({ readonly: true })
+
+export default {
+  async fetch(request, env, context) {
+    return explorer.handle(request, env, context)
+  }
+};
+`
+)
+
+console.log(`Project ${projectName} successfully created!`)
+console.log('----------------------------')
+console.log('Next steps:')
+console.log(` 1. Run 'cd ${projectName} && npm install'`)
+console.log(" 2. Update the 'wrangler.toml' file with your R2 Buckets")
+console.log(" 3. Run 'wrangler publish' to deploy your own R2-Explorer!")
+
+process.exit(0) //no errors occurred

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "r2-explorer",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "A Google Drive Interface for your Cloudflare R2 Buckets",
   "main": "dist/umd/index.js",
   "scripts": {