r2-explorer 0.6.0 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Gabriel Massadas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -5,14 +5,13 @@ 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/
+- Documentation: [r2explorer.dev](https://r2explorer.dev)
+- Live Demo: [demo.r2explorer.dev](https://demo.r2explorer.dev)
 
-This project is still in development, and there are definitely going to be some weird issues sometimes, but when you
-find something
-please [open an new issue](https://github.com/G4brym/R2-Explorer/issues/new) for it to get solved.
 
 ## Features
 
+- [Email Explorer](https://r2explorer.dev/guides/setup-email-explorer/) (using Cloudflare Email Routing)
 - Very quick bucket/folder navigation
 - pdf, image, txt, markdown, csv, etc in-browser preview
 - Drag-and-Drop upload
@@ -25,65 +24,12 @@ please [open an new issue](https://github.com/G4brym/R2-Explorer/issues/new) for
 - Multipart upload for big files
 - Cloudflare Access validation using jwt
 
-## Configurations
-
-These options are defined in the `index.js` file, in the `R2Explorer({ readonly: false, ... })`.
-
-| Name               | Type(s)                  | Description                                                           | Examples                                                  |
-|--------------------|--------------------------|-----------------------------------------------------------------------|-----------------------------------------------------------|
-| `readonly`         | `boolean` or `undefined` | Controls the write access globally, default: `true`                   | `true`                                                    |
-| `cors`             | `boolean` or `undefined` | Enables or disables CORS access to the internal API, default: `false` | `true`                                                    |
-| `cfAccessTeamName` | `string`  or `undefined` | When set enforces Cloudflare Access in all requests                   | `radar`  (taken from https://radar.cloudflareaccess.com/) |
-
-
-## 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.
-
-___
-
-Q. Can i upload files bigger than 100MB?
-
-A. Yes! R2-Explorer now
-support's [Multipart Upload](https://developers.cloudflare.com/r2/data-access/workers-api/workers-multipart-usage/),
-that splits the files you are uploading in about 95MB chunks for uploading within the Cloudflare 100MB uploading limit.
-
 ## 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
+npm create r2-explorer@latest
 ```
 
 ## Upgrading your installation
@@ -108,46 +54,19 @@ wrangler publish
 - Image thumbnail's using Cloudflare workers
 - Tooltip when hovering a file with absolute time in "x days time ago" format
 - Automatically load more files, when the bottom is reached (current limit is 1000 files)
-- Download files bigger than 2gb with presigned url's
-- set file navigation in the url to allow direct share of a specific file
-- only support previews to files under 100mb
+- bundle bootstrap icons instead of importing
 
 ## 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/main/docs/images/home.png)
-
-Image Previewer
-![Home](https://github.com/G4brym/R2-Explorer/raw/main/docs/images/image-preview.png)
-
-Pdf Previewer
-![Home](https://github.com/G4brym/R2-Explorer/raw/main/docs/images/pdf-preview.png)
-
-New Folder
-![Home](https://github.com/G4brym/R2-Explorer/raw/main/docs/images/new-folder.png)
 
-Uploading Files
-![Home](https://github.com/G4brym/R2-Explorer/raw/main/docs/images/uploading-files.png)
-
-### Compiles and hot-reloads for development
-
-```
-npm run serve
-```
-
-### Compiles and minifies for production
+## Development
 
+Publish Dashboard into dev branch
 ```
+cd packages/dashboard/
 npm run build
-```
-
-### Lints and fixes files
-
-```
-npm run lint
+wrangler pages publish --branch dev --project-name r2-explorer-dashboard dist/
 ```