Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PacoVK authored Nov 9, 2024
1 parent e23e3c2 commit 83e9b30
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## SQS-Admin
# SQS-Admin

<p>
<a href="https://github.com/PacoVK/sqs-admin?tab=readme-ov-file#contributors-">
Expand All @@ -13,28 +13,28 @@ A minimal and lightweight UI for managing SQS-Queues for local development e.g.

![Sqs-Admin](screenshot.png)

### Why
## Why

There are already good UIs for SQS, but they are heavy with sizes >100 MB. Most likely because they ship with SQS itself.
If you choose e.g. Localstack for local development you don't need an additional local SQS setup, as it is already
provided by Localstack, unfortunately without UI.
This Alpine based image has a size ~19 MB. You can easily manage and create Queues.

### Usage
## Usage

The most common way to use SQS-Admin would be in conjunction with a `docker-compose.yml`.
A working example can be found in the `example` directory.

You probably need to have a SQS up and running somewhere to connect to, e.g. via Localstack.
To start SQS-Admin simply run:
`docker run --rm -p 3999:3999 -e SQS_ENDPOINT_URL=[Endpoint-URL-of-our-SQS] -d pacovk/sqs-admin`
`docker run --rm -p 3999:3999 -e SQS_ENDPOINT_URL=<Endpoint-URL-of-our-SQS> -d pacovk/sqs-admin`

### Compatibility
## Compatibility

SQS-Admin >= 0.5.4 does not support Localstack < 2.x. If you need to stick to Localstack 1.x, please use SQS-Admin <= 0.5.3 ([see #928](https://github.com/PacoVK/sqs-admin/issues/928))
**Localstack >= 3.5.0** is currently not supported, due to breaking changes.

### Configuration
## Configuration

You can easily configure the Docker Container via the following environment variables:

Expand All @@ -43,13 +43,13 @@ You can easily configure the Docker Container via the following environment vari
| SQS_ENDPOINT_URL | **Endpoint where SQS is running, this one is mostly required** | http://localhost:4566 |
| SQS_AWS_REGION | AWS region the client internally uses to interact with SQS | eu-central-1 |

### Contributing
## Contributing

If you want to contribute to this project, please read the [contribution guidelines](./CONTRIBUTING.md).

### Development
## Development

#### Run local environment
### Run local environment

To 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).

Expand All @@ -59,19 +59,19 @@ To configure the backend for local development you can set the following environ
| --------- | ------------------------------------------------------ | ------- |
| HTTP_PORT | Port that the internal backend binds to and is serving | 3999 |

#### Run tests
### Run tests

To run the tests you can run `make test`. You'll need to shut down your local development environment afterward.

#### Shutdown local environment
### Shutdown local environment

To shutdown your local development environment you can run `make down`.

### Designed and tested with
## Designed and tested with

![Localstack](https://raw.githubusercontent.com/localstack/.github/main/assets/localstack-readme-banner.svg)

### Contributors ✨
## Contributors ✨

Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Expand Down

0 comments on commit 83e9b30

Please sign in to comment.