{"id":16516067,"url":"https://github.com/sketchingdev/serverlessrealtimereporter","last_synced_at":"2025-03-02T17:14:19.345Z","repository":{"id":75195531,"uuid":"220711952","full_name":"SketchingDev/ServerlessRealtimeReporter","owner":"SketchingDev","description":"Demo app for reporting the progress of automated processes in realtime using AppSync","archived":false,"fork":false,"pushed_at":"2020-08-03T08:35:51.000Z","size":454,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-13T04:21:32.012Z","etag":null,"topics":["appsync","aws","lambda","nodejs","serverless","sqs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SketchingDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-11-09T22:31:04.000Z","updated_at":"2020-08-03T08:34:45.000Z","dependencies_parsed_at":"2023-06-05T17:30:24.111Z","dependency_job_id":null,"html_url":"https://github.com/SketchingDev/ServerlessRealtimeReporter","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/SketchingDev%2FServerlessRealtimeReporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SketchingDev%2FServerlessRealtimeReporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SketchingDev%2FServerlessRealtimeReporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SketchingDev%2FServerlessRealtimeReporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SketchingDev","download_url":"https://codeload.github.com/SketchingDev/ServerlessRealtimeReporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241541451,"owners_count":19979121,"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":["appsync","aws","lambda","nodejs","serverless","sqs"],"created_at":"2024-10-11T16:19:22.459Z","updated_at":"2025-03-02T17:14:19.305Z","avatar_url":"https://github.com/SketchingDev.png","language":"TypeScript","readme":"# Serverless Realtime Reporter\n\n[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)\n\nA demonstration of a Serverless application for reporting the progress of automated processes in realtime through a UI.\n\nIn this example processes update their progress by pushing Commands to a queue, although it could be extended to other\nmediums e.g. CloudWatch.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/architecture.png\"\u003e\n\u003c/p\u003e\n\nAt the centre of the application is AppSync (AWS's fully managed GraphQL instance) which manages the state. It pushes\ndata to the UI via subscriptions and receives data from a Lambda via mutations. SQS invokes the Lambda with commands\npushed to it by automated processes.\n\n## Using a restricted deployment user\n\nThis solution can be deployed with a user that only has the necessary permissions - although they're not as restricted\nas they could be.\n\n**Creating User**\n\n```bash\naws cloudformation create-stack \\\n  --stack-name realtime-deployment-user \\\n  --capabilities CAPABILITY_NAMED_IAM \\\n  --template-body file://./.github/deployment-user.yml\n```\n\n**Updating User**\n\n```bash\naws cloudformation update-stack \\\n  --stack-name realtime-deployment-user \\\n  --capabilities CAPABILITY_NAMED_IAM \\\n  --template-body file://./.github/deployment-user.yml\n```\n\n### Configuring development environment\n\nFollow these steps to configure your environment to use the deployment user.\n\n```bash\n# 1. Retrieve user's Access Key and Secret\naws cloudformation describe-stacks --stack-name realtime-deployment-user\n\n# 2. Create profile for user\naws configure --profile process-reporter-deployer\n\n# 3. Example of performing an action using this new profile\nAWS_PROFILE=process-reporter-deployer yarn test:integration\n```\n\n## Improvements\n\n* Using queries in place of scans for DynamoDB\n* Using EventBridge with a schema registry\n* Use [event sourcing with projections](https://stackoverflow.com/a/47313279) for Commands\n* Implement pagination\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsketchingdev%2Fserverlessrealtimereporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsketchingdev%2Fserverlessrealtimereporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsketchingdev%2Fserverlessrealtimereporter/lists"}