https://github.com/paritoshbh/s3-explorer

GUI for browsing S3 buckets, to facilitate local development. Currently tested against localstack & MinIO.
https://github.com/paritoshbh/s3-explorer

browser explorer gui s3

Last synced: 4 months ago
JSON representation

GUI for browsing S3 buckets, to facilitate local development. Currently tested against localstack & MinIO.

• Host: GitHub
• URL: https://github.com/paritoshbh/s3-explorer
• Owner: ParitoshBh
• License: mit
• Created: 2022-12-04T22:36:19.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-10T00:58:27.000Z (about 1 year ago)
• Last Synced: 2025-07-19T18:05:19.446Z (12 months ago)
• Topics: browser, explorer, gui, s3
• Language: Handlebars
• Homepage:
• Size: 871 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @smblitz/s3explorer

GUI for browsing S3 buckets, to facilitate local development. Currently tested against [localstack](https://github.com/localstack/localstack) and [MinIO](https://github.com/minio/minio).

![Bucket List](screenshots/bucket_list.png)

![Object Actions](screenshots/object_actions.png)

## Using Package

To run the package using `npx` run following command,

```sh

# export variable that'll be used by package

export S3_ENDPOINT=

export S3_ACCESS_KEY_ID=

export S3_SECRET_ACCESS_KEY=

# finally run the package directly using npx

npx @smblitz/s3explorer

```

### Supported Environment Variables

- PORT (optional, application port, defaults to `3000`)

- S3_REGION (optional, default `us-east-1`)

- S3_ENDPOINT (required)

- S3_ACCESS_KEY_ID (required)

- S3_SECRET_ACCESS_KEY (required)

## Dev Setup

If you'd like to contribute to the package,

1. Clone this repository

1. If you have Visual Studio Code installed, open the cloned repository in it and it'll prompt you to open in container.

1. Once in container, run the package locally using following command in dev container,

   ```sh

    # export variable that'll be used by package

    export S3_ENDPOINT=http://s3:4566

    export S3_ACCESS_KEY_ID=1234

    export S3_SECRET_ACCESS_KEY=1234

    # start in watch mode

    npm run nodemon

   ```

If you'd like to populate Localstack S3 container (started when you open this repository in Visual Studio Code) with fake data then run following,

```js

npm run populateS3

```