{"id":18636811,"url":"https://github.com/PacoVK/sqs-admin","last_synced_at":"2025-04-11T09:31:12.604Z","repository":{"id":36950787,"uuid":"493273960","full_name":"PacoVK/sqs-admin","owner":"PacoVK","description":"A simple UI for local SQS","archived":false,"fork":false,"pushed_at":"2025-04-09T19:11:34.000Z","size":6284,"stargazers_count":65,"open_issues_count":8,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T20:23:54.114Z","etag":null,"topics":["administration","alpine","aws","aws-sqs","docker","hacktoberfest","localstack","sqs","sqs-insight","webui"],"latest_commit_sha":null,"homepage":"https://pascal.euhus.dev/sqs-admin/","language":"TypeScript","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/PacoVK.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":"pacoVK","custom":["https://www.paypal.com/donate/?hosted_button_id=NC846BADKGTJG"]}},"created_at":"2022-05-17T13:56:11.000Z","updated_at":"2025-04-05T05:26:16.000Z","dependencies_parsed_at":"2023-10-31T21:22:11.246Z","dependency_job_id":"c8a4e78b-f671-4b9e-af64-ef92cd87e4d1","html_url":"https://github.com/PacoVK/sqs-admin","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PacoVK%2Fsqs-admin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PacoVK%2Fsqs-admin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PacoVK%2Fsqs-admin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PacoVK%2Fsqs-admin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PacoVK","download_url":"https://codeload.github.com/PacoVK/sqs-admin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248368209,"owners_count":21092317,"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":["administration","alpine","aws","aws-sqs","docker","hacktoberfest","localstack","sqs","sqs-insight","webui"],"created_at":"2024-11-07T05:32:27.556Z","updated_at":"2025-04-11T09:31:12.597Z","avatar_url":"https://github.com/PacoVK.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/11fe5716-16c6-46e5-b64f-a992c2ba0773\" /\u003e\n\u003c/p\u003e\n\n\u003cp\u003e  \n  \u003ca href=\"https://github.com/PacoVK/sqs-admin?tab=readme-ov-file#contributors-\"\u003e\n    \u003cimg alt=\"Contributors\" src=\"https://img.shields.io/github/all-contributors/pacovk/sqs-admin\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://hub.docker.com/r/pacovk/sqs-admin\"\u003e\n    \u003cimg alt=\"Docker Pulls\" src=\"https://img.shields.io/docker/pulls/pacovk/sqs-admin\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://cdn.localstack.cloud/gh/extension-badge.svg\"\u003e\n    \u003cimg alt=\"Localstack extension\" src=\"https://cdn.localstack.cloud/gh/extension-badge.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nA minimal and lightweight UI for managing SQS-Queues for local development e.g. with [Localstack](https://localstack.cloud/).\n\n![Sqs-Admin](screenshot.png)\n\n## Why\n\nThere are already good UIs for SQS, but they are heavy with sizes \u003e100 MB. Most likely because they ship with SQS itself.\nIf you choose e.g. Localstack for local development you don't need an additional local SQS setup, as it is already\nprovided by Localstack, unfortunately without UI.\n**This image has a size ~8 MB**. You can easily manage and create Queues.\n\n## Usage\n\n### Standalone Mode\n\nThe most common way to use SQS-Admin would be in conjunction with a `docker-compose.yml`.\nA working example can be found in the `example` directory.\n\nYou probably need to have a SQS up and running somewhere to connect to, e.g. via Localstack.\nTo start SQS-Admin simply run:\n`docker run --rm -p 3999:3999 -e SQS_ENDPOINT_URL=\u003cEndpoint-URL-of-our-SQS\u003e -d pacovk/sqs-admin`\n\n### LocalStack Extension\n\nSQS-Admin can also be used as a LocalStack extension, which provides a more integrated experience.\n\nMore details [here](./localstack/README.md).\n\n## Compatibility\n\nSQS-Admin \u003e= 0.5.4 does not support Localstack \u003c 2.x. \nIf you need to stick to Localstack 1.x, please use SQS-Admin \u003c= 0.5.3 ([see #928](https://github.com/PacoVK/sqs-admin/issues/928))\n\n## Configuration\n\nYou can easily configure the Docker Container via the following environment variables:\n\n| ENV              | Description                                                    | Default               |\n| ---------------- | -------------------------------------------------------------- | --------------------- |\n| SQS_ENDPOINT_URL | **Endpoint where SQS is running, this one is mostly required** | http://localhost:4566 |\n| SQS_AWS_REGION   | AWS region the client internally uses to interact with SQS     | eu-central-1          |\n\n## Contributing\n\nIf you want to contribute to this project, please read the [contribution guidelines](./CONTRIBUTING.md).\n\n## Development\n\n### Run local environment\n\nTo start your local development environment you can run `make dev`. This will start a local backend (default http://localhost:3999) and the UI (default http://localhost:3000).\n\nThe frontend is built with Vite for a faster and more efficient development experience.\n\nTo configure the backend for local development you can set the following environment variable:\n\n| ENV       | Description                                            | Default |\n| --------- | ------------------------------------------------------ | ------- |\n| HTTP_PORT | Port that the internal backend binds to and is serving | 3999    |\n\n### Run tests\n\nTo run the tests you can run `make test`. You'll need to shut down your local development environment afterward.\n\n### Shutdown local environment\n\nTo shutdown your local development environment you can run `make down`.\n\n### Release\n\nTo release a new version: \n* Update `vite.config.ts` \n* Update `package.json`\n* Update `./localstack/pyproject.toml`\n* Create a new release on GitHub\n\n## Designed and tested with\n\n![Localstack](https://raw.githubusercontent.com/localstack/.github/main/assets/localstack-readme-banner.svg)\n\n## Contributors ✨\n\nThanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://pascal.euhus.dev/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/27785614?v=4?s=100\" width=\"100px;\" alt=\"PacoVK\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ePacoVK\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/PacoVK/sqs-admin/commits?author=PacoVK\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/PacoVK/sqs-admin/pulls?q=is%3Apr+reviewed-by%3APacoVK\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"#projectManagement-PacoVK\" title=\"Project Management\"\u003e📆\u003c/a\u003e \u003ca href=\"#maintenance-PacoVK\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"#example-PacoVK\" title=\"Examples\"\u003e💡\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://erico.dev.br\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10657645?v=4?s=100\" width=\"100px;\" alt=\"Érico Knapp Lutzer\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eÉrico Knapp Lutzer\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/PacoVK/sqs-admin/commits?author=klutzer\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/stasadev\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/24270994?v=4?s=100\" width=\"100px;\" alt=\"Stanislav Zhuk\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eStanislav Zhuk\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/PacoVK/sqs-admin/commits?author=stasadev\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/AlejandroPerez92\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/112934187?v=4?s=100\" width=\"100px;\" alt=\"Alejandro Perez\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAlejandro Perez\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/PacoVK/sqs-admin/commits?author=AlejandroPerez92\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/adambordas\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/6266706?v=4?s=100\" width=\"100px;\" alt=\"Ádám Bordás\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eÁdám Bordás\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/PacoVK/sqs-admin/issues?q=author%3Aadambordas\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/bhavishyachandra\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10553920?v=4?s=100\" width=\"100px;\" alt=\"Bhavishya Chandra Kamineni\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBhavishya Chandra Kamineni\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/PacoVK/sqs-admin/commits?author=bhavishyachandra\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://www.danielneto.pt\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10155766?v=4?s=100\" width=\"100px;\" alt=\"Daniel Neto\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDaniel Neto\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/PacoVK/sqs-admin/commits?author=danielnetop\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n#### Legal note\n\nUI favicon by [John Sorrentino](https://favicon.io/emoji-favicons/cowboy-hat-face)\n","funding_links":["https://github.com/sponsors/pacoVK","https://www.paypal.com/donate/?hosted_button_id=NC846BADKGTJG"],"categories":["User Interface"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPacoVK%2Fsqs-admin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPacoVK%2Fsqs-admin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPacoVK%2Fsqs-admin/lists"}