{"id":15587877,"url":"https://github.com/v-checha/aws-lambda-dynamodb-serverless-starter","last_synced_at":"2025-09-15T18:24:59.177Z","repository":{"id":221130810,"uuid":"753504707","full_name":"v-checha/aws-lambda-dynamodb-serverless-starter","owner":"v-checha","description":"It is a serverless application that uses AWS lambda, dynamodb, and api gateway. It is written in typescript and uses the serverless framework.","archived":false,"fork":false,"pushed_at":"2024-04-13T15:41:26.000Z","size":118,"stargazers_count":29,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-24T04:51:29.250Z","etag":null,"topics":["api-gateway","dynamodb","dynamodb-admin","dynamodb-offline","lambda","middify","serverless","serverless-offline"],"latest_commit_sha":null,"homepage":"https://www.nodeteam.onix-systems.com/","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/v-checha.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,"zenodo":null}},"created_at":"2024-02-06T08:59:17.000Z","updated_at":"2024-09-19T21:06:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"206d3ff7-ba9e-43dc-8f2c-dec345713d9c","html_url":"https://github.com/v-checha/aws-lambda-dynamodb-serverless-starter","commit_stats":null,"previous_names":["nodeteamdev/aws-lambda-dynamodb-serverless-starter"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/v-checha/aws-lambda-dynamodb-serverless-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v-checha%2Faws-lambda-dynamodb-serverless-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v-checha%2Faws-lambda-dynamodb-serverless-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v-checha%2Faws-lambda-dynamodb-serverless-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v-checha%2Faws-lambda-dynamodb-serverless-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/v-checha","download_url":"https://codeload.github.com/v-checha/aws-lambda-dynamodb-serverless-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v-checha%2Faws-lambda-dynamodb-serverless-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275301033,"owners_count":25440566,"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","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"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":["api-gateway","dynamodb","dynamodb-admin","dynamodb-offline","lambda","middify","serverless","serverless-offline"],"created_at":"2024-10-02T22:20:19.542Z","updated_at":"2025-09-15T18:24:59.132Z","avatar_url":"https://github.com/v-checha.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Description\nIt is a serverless application that uses AWS lambda, dynamodb, and api gateway. It is written in typescript and uses the serverless framework.\n\n# Setup\n## Prerequisites\n- nodejs\n- npm\n- serverless framework\n- aws cli\n- aws credentials\n- dynamodb local\n- dynamodb admin\n- dynamodb migrate\n- Java Runtime Engine (JRE) version 6.x or newer\n\n# Features\n\n- User\n  - Create a user\n  - Get a user\n  - Update a user\n  - Delete a user\n- Shop\n    - Create a shop\n    - Get a shop\n- Mail - send an email via [AWS SES](https://aws.amazon.com/ses/)\n\n## Installation\n\nSetup npm dependencies\n\n```bash\nnpm install\n```\n\nSetup serverless framework\n\n```bash\nnpm install -g serverless\n```\n\nInstall dynamodb local\n\nDynamoDb Oflline Plugin Requires:\n - serverless@^1\n - Java Runtime Engine (JRE) version 6.x or newer\n\n```bash\nnpx sls dynamodb install\n```\n\nInstall dynamodb admin\n\n```bash\nnpm install -g dynamodb-admin\n```\nafter installation, run the following command to start dynamodb admin\n```bash\ndynamodb-admin\n```\n_note: admin will be available at http://localhost:8001\n\nInstall dynamodb migrate\n\n```bash\nnpm install -g dynamodb-migrate\n```\n\n## Run\n```bash\nnpx serverless offline start --stage=dev\n```\n\n## Deploy\n```bash\nnpx serverless deploy --stage=\u003cname\u003e\n```\n\n## Remove\n```bash\nnpx serverless remove --stage=\u003cname\u003e\n```\n\n# API Documentation\nWill be available at  http://localhost:3000/swagger\n\n# Project Structure\n```bash\nsrc\n├── functions\n│   ├── mail\n│   │   ├── handler.ts\n│   │   └── routes.ts\n│   ├── shop\n│   │   ├── handler.ts\n│   │   └── routes.ts\n│   └── user\n│       ├── handler.ts\n│       └── routes.ts\n├── libs\n│   ├── api-gateway.ts\n│   ├── handler-resolver.ts\n│   └── lambda.ts\n├── model\n│   ├── Shop.ts\n│   ├── User.ts\n│   └── index.ts\n└── services\n    ├── index.ts\n    ├── shop-service.ts\n    └── user-service.ts\n```\nEach function has its own folder with a handler and routes file. The handler file contains the lambda function and the routes file contains the api gateway routes.\nExample of the handler file:\n```typescript\nconst create = middyfy(\n    {\n        type: 'object',\n        required: ['body'],\n        properties: {\n            body: {\n                type: 'object',\n                required: ['email'],\n                properties: {\n                    email: { type: 'string', format: 'email' },\n                },\n            },\n        },\n    },\n    async (event: APIGatewayProxyEventWithBody\u003cany\u003e): Promise\u003cAPIGatewayProxyResult\u003e =\u003e {\n        const user = await userService.create({\n            email: event.body.email,\n            userId: uuidv4(),\n            isVerified: false,\n        });\n\n        return formatJSONResponse({\n            user,\n        });\n    },\n);\n```\n`middify` - is a helper function that wraps the lambda function with params validation and error handling.\n\n# Contributing Guide\n## Branching\n- `master` - production branch\n- `dev` - development branch\n- `feature/\u003cname\u003e` - feature branch\n- `bugfix/\u003cname\u003e` - bugfix branch\n- `hotfix/\u003cname\u003e` - hotfix branch\n- `release/\u003cname\u003e` - release branch\n- `docs/\u003cname\u003e` - documentation branch\n- `test/\u003cname\u003e` - test branch\n- `chore/\u003cname\u003e` - chore branch\n- `refactor/\u003cname\u003e` - refactor branch\n- `style/\u003cname\u003e` - style branch\n- `ci/\u003cname\u003e` - ci branch\n\n## Commit Message\n```bash\n\u003ctype\u003e[optional scope]: \u003cdescription\u003e\n```\nExample:\n```bash\nfeat(api): send an email to the customer when a product is shipped\n```\nCommit message should be with the next format - conventionalcommits We are use commitizen for commit message formatting.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fv-checha%2Faws-lambda-dynamodb-serverless-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fv-checha%2Faws-lambda-dynamodb-serverless-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fv-checha%2Faws-lambda-dynamodb-serverless-starter/lists"}