{"id":16827654,"url":"https://github.com/ghostsquad/s3-file-explorer","last_synced_at":"2025-03-17T20:13:28.256Z","repository":{"id":137362291,"uuid":"549130792","full_name":"ghostsquad/s3-file-explorer","owner":"ghostsquad","description":null,"archived":false,"fork":false,"pushed_at":"2022-10-11T19:17:16.000Z","size":159,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-09T00:45:56.260Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ghostsquad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-10T18:13:08.000Z","updated_at":"2022-10-10T19:53:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"8e2ff461-7e5f-41a2-887c-fff3125f72cc","html_url":"https://github.com/ghostsquad/s3-file-explorer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostsquad%2Fs3-file-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostsquad%2Fs3-file-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostsquad%2Fs3-file-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostsquad%2Fs3-file-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ghostsquad","download_url":"https://codeload.github.com/ghostsquad/s3-file-explorer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244102850,"owners_count":20398386,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T11:22:13.916Z","updated_at":"2025-03-17T20:13:28.228Z","avatar_url":"https://github.com/ghostsquad.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003ca href=\"http://github.com/ghostsquad/s3-file-explorer\"\u003e\u003cimg src=\"./docs/assets/cloud-service.png\" alt=\"github.com/ghostsquad/s3-file-explorer\" width=\"200px\" /\u003e\u003c/a\u003e\n  \u003cbr\u003e\n  S3 File Explorer\n  \u003cbr\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#introduction\"\u003eIntroduction\u003c/a\u003e •\n  \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e •\n  \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e •\n  \u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\n\u003c/p\u003e\n\n## Introduction\n\nA Simple S3 File Explorer. Make a request to `/p/` to see what's in the configured bucket.\n\n## Getting Started\n\n```shell\ntask run\n```\n\nIn a separate shell\n\n```shell\ntask http:paths\n\ntask http:metrics\n```\n\n### Configuration\n\nConfiguration is done via environment variables. Standard AWS SDK Environment variables supported, as well as OIDC/EC2 authentication methods.\n\n| Variable       | Required | Default                              | Description                                                    |\n|----------------|----------|--------------------------------------|----------------------------------------------------------------|\n| `AWS_BUCKET`   | no       | `github-ghostsquad-s3-file-explorer` | The AWS Bucket to explorer                                     |\n| `PORT`         | no       | `8080`                               | The listen port                                                |\n| `BIND_ADDRESS` | no       |                                      | Configured to listen on 127.0.0.1, this may not work in Docker |\n\n## Contributing\n\n```shell\nbrew install asdf\nasdf plugin-add task https://github.com/particledecay/asdf-task.git\nasdf plugin add python\n\nasdf install\n\ntask test\n```\n\n## Roadmap\n\n- [ ] Make a roadmap\n\n### Known Issues\n\n1. I have unit tests, and I manually ran some integration tests, but not all integration tests work, so I need to understand a bit more about how gin handles trailing slashes, AWS prefix expectations, etc.\n\n    ![integration test results](./docs/assets/integration-test-results.png)\n\n2. I had to use the Docker Image deployment method because building wasn't going to work, as I'd have some drift in how I configured some build args.\n3. There's a slew of app optimizations still left, such as separating `/ping` and `/metrics` endpoints onto different listeners, make logging configurable between text/color and JSON and some other things. This was my first time using Gin.\n4. I didn't write any terraform/pulumi code to use OIDC to authenticate the app. I would prefer that over what I did manually (create a user and access key), but those environment variables were part of the original requirements.\n5. I didn't configure test coverage or pay attention to that much. Just wrote a few small unit tests and a sanity-check end2end test (just verifies that the app runs and I can /ping it) via docker-compose.\n\n## Attribution\n\n\u003ca href=\"https://www.flaticon.com/free-icons/function\" title=\"function icons\"\u003eFunction icons created by Freepik - Flaticon\u003c/a\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghostsquad%2Fs3-file-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fghostsquad%2Fs3-file-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghostsquad%2Fs3-file-explorer/lists"}