{"id":18573167,"url":"https://github.com/localstack-samples/sample-item-tracker-shipyard-application","last_synced_at":"2026-04-18T11:01:31.514Z","repository":{"id":235231227,"uuid":"790005905","full_name":"localstack-samples/sample-item-tracker-shipyard-application","owner":"localstack-samples","description":"Full-Stack Item tracker application utilizing LocalStack and deployed via Shipyard's Ephemeral Environments ","archived":false,"fork":false,"pushed_at":"2024-04-22T05:13:19.000Z","size":3474,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-15T23:12:48.428Z","etag":null,"topics":["dynamodb","flask","localstack","react","ses","shipyard"],"latest_commit_sha":null,"homepage":"","language":"Python","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/localstack-samples.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}},"created_at":"2024-04-22T05:01:40.000Z","updated_at":"2024-04-22T17:11:10.000Z","dependencies_parsed_at":"2024-04-22T19:15:02.823Z","dependency_job_id":"dc3e0e61-03f8-4217-ae95-3071bb4aec52","html_url":"https://github.com/localstack-samples/sample-item-tracker-shipyard-application","commit_stats":null,"previous_names":["localstack-samples/sample-item-tracker-shipyard-application"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/localstack-samples/sample-item-tracker-shipyard-application","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack-samples%2Fsample-item-tracker-shipyard-application","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack-samples%2Fsample-item-tracker-shipyard-application/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack-samples%2Fsample-item-tracker-shipyard-application/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack-samples%2Fsample-item-tracker-shipyard-application/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/localstack-samples","download_url":"https://codeload.github.com/localstack-samples/sample-item-tracker-shipyard-application/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack-samples%2Fsample-item-tracker-shipyard-application/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31966217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["dynamodb","flask","localstack","react","ses","shipyard"],"created_at":"2024-11-06T23:08:15.493Z","updated_at":"2026-04-18T11:01:31.489Z","avatar_url":"https://github.com/localstack-samples.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Item Tracker application with LocalStack \u0026 Shipyard\n\n| Key          | Value                                                                              |\n| ------------ | ---------------------------------------------------------------------------------- |\n| Environment  | LocalStack, AWS                                                                    |\n| Services     | SES, DynamoDB                                                                      |\n| Integrations | Shipyard, AWS CLI, CDK                                                             |\n| Categories   | Web Application                                                                    |\n| Level        | Basic                                                                              |\n| GitHub       | [Repository link](https://github.com/HarshCasper/localstack-shipyard-item-tracker) |\n\n## Introduction\n\nThis application demonstrates how to build a simple item tracker application using React \u0026 Flask with LocalStack provisioning AWS resources, such as DynamoDB and SES. The application uses Shipyard to create [ephemeral environments](https://docs.shipyard.build/docs/) for each pull request, and it uses Docker Compose to deploy the application services.\n\nThis application uses the AWS SDK for Python (Boto3) to establish a REST service, while performing the following actions:\n\n- Develop a Flask-based REST service that seamlessly integrates with a React client \u0026 AWS services.\n- Manage operations such as reading, writing, and updating work items stored in an DynamoDB table.\n- Send email reports containing work item details using Simple Email Service (SES) from the React client.\n\n## Prerequisites\n\n- LocalStack with the [`localstack` CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli).\n- [AWS CLI](https://docs.localstack.cloud/user-guide/integrations/aws-cli/) with the [`awslocal` wrapper](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal).\n- [Node.js](https://nodejs.org/en/) with the `npm` package manager.\n- [Python](https://www.python.org/downloads/) with `pip` in the `PATH`\n- [Docker](https://docs.docker.com/get-docker/) with [`docker-compose`](https://docs.docker.com/compose/install/) installed.\n- Optional:\n    - [Cloud Development Kit (CDK)](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html) installed with the [`cdklocal` wrapper](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/).\n\nStart LocalStack on your local machine using the following command:\n\n```shell\nDEBUG=1 localstack start\n```\n\n## Running the application locally\n\nYou can run the application locally using `docker-compose`. The `docker-compose.yml` file contains the configuration for the Flask REST service, the React client, and the LocalStack services. Run the following command to start the application:\n\n```shell\ndocker-compose up\n```\n\nThe below sections provide the manual steps to create the AWS resources and start the Flask REST service and React client.\n\n### Create a DynamoDB table\n\nYou can use LocalStack to create a local DynamoDB table. Run the following command to create a table named `doc-example-work-item-tracker`:\n\n```shell\nawslocal dynamodb create-table \\\n    --table-name doc-example-work-item-tracker \\\n    --attribute-definitions AttributeName=iditem,AttributeType=S \\\n    --key-schema AttributeName=iditem,KeyType=HASH \\\n    --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5\n```\n\nIn addition, we need to verify an email identity to send emails using SES. Run the following command to verify an email identity:\n\n```shell\nawslocal ses verify-email-identity --email hello@example.com\n```\n\nYou can run the following command to list the email identities:\n\n```shell\nawslocal ses list-identities\n```\n\n### Start the Flask REST service\n\nBefore starting the Flask REST service, install the required Python packages using the following command:\n\n```shell\ncd backend\nvirtualenv .venv\nsource .venv/bin/activate # macOS/Linux; use .venv\\Scripts\\activate on Windows\npip install -r requirements.txt\n```\n\nYou can start the Flask REST service using the following command in the `backend` directory:\n\n```shell\npython app.py\n```\n\nThe backend service will start on `http://localhost:8080`. To test the service, you can use the following `curl` command:\n\n```shell\ncurl -X POST http://localhost:8080/api/items \\\n-H \"Content-Type: application/json\" \\\n-d '{\"name\":\"Me\",\"guide\":\"python\",\"description\":\"Show how to add an item\",\"status\":\"In progress\",\"archived\":false}'\n```\n\n### Start the React client\n\nBefore starting the React client, install the required Node.js packages using the following command:\n\n```shell\ncd frontend\nnpm install\n```\n\nYou can start the React client using the following command in the `frontend` directory:\n\n```shell\nnpm start\n```\n\nThe following command will start the React client on `http://localhost:3000/item_tracker`. You can use the client to add, update, and delete work items.\n\n![React application](images/application.png)\n\n## Running the application with Shipyard\n\nWIP\n\n## Learn more\n\nThe application is based on a [public AWS tutorial](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/example_cross_DynamoDBDataTracker_section.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalstack-samples%2Fsample-item-tracker-shipyard-application","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocalstack-samples%2Fsample-item-tracker-shipyard-application","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalstack-samples%2Fsample-item-tracker-shipyard-application/lists"}