{"id":18879780,"url":"https://github.com/joshuatoth/serverless-api-typescript-template","last_synced_at":"2025-04-14T19:23:34.364Z","repository":{"id":44108139,"uuid":"196955823","full_name":"JoshuaToth/serverless-api-typescript-template","owner":"JoshuaToth","description":"A template for a Serverless API using Typescript and Jest","archived":false,"fork":false,"pushed_at":"2023-03-01T13:58:04.000Z","size":666,"stargazers_count":12,"open_issues_count":13,"forks_count":8,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-28T07:51:10.453Z","etag":null,"topics":[],"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/JoshuaToth.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-07-15T08:20:38.000Z","updated_at":"2024-11-05T05:22:26.000Z","dependencies_parsed_at":"2024-11-08T11:00:45.304Z","dependency_job_id":null,"html_url":"https://github.com/JoshuaToth/serverless-api-typescript-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoshuaToth%2Fserverless-api-typescript-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoshuaToth%2Fserverless-api-typescript-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoshuaToth%2Fserverless-api-typescript-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoshuaToth%2Fserverless-api-typescript-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JoshuaToth","download_url":"https://codeload.github.com/JoshuaToth/serverless-api-typescript-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248943533,"owners_count":21186981,"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":[],"created_at":"2024-11-08T06:39:24.594Z","updated_at":"2025-04-14T19:23:34.323Z","avatar_url":"https://github.com/JoshuaToth.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serverless API: Typescript and Jest Template\nA Serverless API template using Typescript and Jest.\n\nThis setup uses AWS as the provider. \n\nTo use your own provider, edit the `serverless.yml` as needed.\nThe endpoint for the tests to run against will also need to be set to be more specific to your provider.\n\n## Getting up and running\nFirst install `serverless` and get that up and running. documentation [here](https://serverless.com/framework/docs/providers/aws/guide/quick-start/).\n\nYou can use the standard `sls` commands or utilise the npm scripts in the project.\n\nThen:\n\n```\nnpm install\n```\n\n## Deployment - Dev\n\n```\nnpm run deploy\n```\n\n## Deployment - Prod\n```\nnpm run deploy:prod\n```\n\n## To remove:\n```\nnpm run remove\n```\n\n# API interactions\nThe API url can be found either the console output, or programatically accessed via the `.serverless/output.json` object.\n\n## GET: Healthcheck\nTest the service is up\n\n```\n/healthcheck\n```\n\n# Testing\nThis template uses Jest (Typescript) to run its tests.\n\nTo test, first deploy the application to your desired AWS stack.\nThen run\n```\nnpm run test\n```\n\nThis will use the generated API url to automatically test the application.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshuatoth%2Fserverless-api-typescript-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshuatoth%2Fserverless-api-typescript-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshuatoth%2Fserverless-api-typescript-template/lists"}