{"id":18851734,"url":"https://github.com/greenvine/serverless-ts-boilerplate","last_synced_at":"2026-05-08T15:03:49.100Z","repository":{"id":89389429,"uuid":"135595372","full_name":"GreenVine/serverless-ts-boilerplate","owner":"GreenVine","description":"Typescript Boilerplate for Serverless Framework","archived":false,"fork":false,"pushed_at":"2018-05-31T14:38:23.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-30T16:53:21.218Z","etag":null,"topics":["aws","aws-lambda","boilerplate","serverless","typescript"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/GreenVine.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":"2018-05-31T14:33:58.000Z","updated_at":"2018-05-31T14:39:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"65109434-119f-4284-a956-c77c874e1897","html_url":"https://github.com/GreenVine/serverless-ts-boilerplate","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/GreenVine%2Fserverless-ts-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreenVine%2Fserverless-ts-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreenVine%2Fserverless-ts-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreenVine%2Fserverless-ts-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GreenVine","download_url":"https://codeload.github.com/GreenVine/serverless-ts-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239788642,"owners_count":19697237,"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":["aws","aws-lambda","boilerplate","serverless","typescript"],"created_at":"2024-11-08T03:36:00.871Z","updated_at":"2026-05-08T15:03:44.052Z","avatar_url":"https://github.com/GreenVine.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serverless Typescript Boilerplate\n\n## Environment Variables\n\n```bash\nexport API_DOMAIN=hello.api.example.com # API Gateway Endpoint Domain\n\nexport AWS_REGION=us-east-1 # Deployment Region\n\nexport API_CERT_NAME=*.api.example.com # API Certificate Name (Best match)\n\nexport API_STAGE=v1 # Stage name\n```\n\n## Deployment\n\n### SSL Certificate\n\nThe environment variable `API_CERT_NAME` specifies the certificate name for API Gateway custom domain. The Serverless plugin will do the best-match over this name. Refer to [serverless-domain-manager plugin documentation](https://github.com/amplify-education/serverless-domain-manager) for detailed guidance.\n\n### Custom Domain\n\n#### Set up\n\nTo set up the custom domain for API Gateway, simply run `yarn run sls create_domain` once.\n\nPlease note that this command cannot modify the existing custom domain that created previously by other means, e.g. through AWS Console, API.\n\nSample Output:\n`\nServerless: 'hello.api.example.com' was created/updated. New domains may take up to 40 minutes to be initialized.\n`\n\n#### Tear Down\n\nTo remove the custom domain, run `yarn run sls delete_domain` once.\n\n### Deploy Project\n\nTo deploy or update the project, run `yarn run sls deploy`.\n\n### Destroy Project\n\n:warning: To destroy all resources, run `yarn run sls remove`. **Be careful when running this command towards a production stage name**.\n\n## References\n\n### AWS as the Provider\n\n- [Quick Start Guide](https://serverless.com/framework/docs/providers/aws/guide/quick-start/)\n\n- Serverless Config: [serverless.yml](https://serverless.com/framework/docs/providers/aws/guide/serverless.yml)\n\n- [API Gateway Events](https://serverless.com/framework/docs/providers/aws/events/apigateway)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenvine%2Fserverless-ts-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreenvine%2Fserverless-ts-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenvine%2Fserverless-ts-boilerplate/lists"}