https://github.com/bbc/sqs-consumer-starter
Examples of how to use sqs-consumer for starting out, or for reproductions
https://github.com/bbc/sqs-consumer-starter
aws express sqs sqs-consumer starter template
Last synced: 4 months ago
JSON representation
Examples of how to use sqs-consumer for starting out, or for reproductions
- Host: GitHub
- URL: https://github.com/bbc/sqs-consumer-starter
- Owner: bbc
- Created: 2023-05-06T18:25:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-18T06:20:26.000Z (5 months ago)
- Last Synced: 2026-02-18T11:16:39.183Z (5 months ago)
- Topics: aws, express, sqs, sqs-consumer, starter, template
- Language: TypeScript
- Homepage:
- Size: 336 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SQS Consumer Starter Monorepo
This workspace collects runnable examples for different runtimes as well as a shared suite of automated tests that exercise the [`sqs-consumer`](https://github.com/bbc/sqs-consumer) and [`sqs-producer`](https://github.com/bbc/sqs-producer) packages.
## Getting started
```bash
npm install
```
Run one of the examples (replace the workspace with the one you need):
```bash
npm run start --workspace @sqs-consumer-starter/ts-esm-example
```
## Tests
System-level checks for both the consumer and producer live in `packages/system-tests` and can be invoked with:
```bash
npm run test:system
# or run them (and any other package level tests) all at once
npm test
```
The tests mock the AWS SDK so they run without AWS credentials while still validating the integration surface.
## Canary automation
`scripts/update-canary.mjs` keeps every workspace pinned to the latest `sqs-consumer` canary release. A scheduled workflow (`.github/workflows/canary-monitor.yml`) runs daily and will:
1. Discover the newest canary tag.
2. Update every `package.json` that references `sqs-consumer` to that version.
3. Install dependencies, run the shared system tests, and open a pull request with the results whenever updates are required.
You can also run the updater locally:
```bash
node scripts/update-canary.mjs
npm install
npm run test:system
```