{"id":19852535,"url":"https://github.com/thesoftwarehouse/serverless-boilerplate","last_synced_at":"2025-05-02T00:31:23.080Z","repository":{"id":37488337,"uuid":"308368867","full_name":"TheSoftwareHouse/serverless-boilerplate","owner":"TheSoftwareHouse","description":"Boilerplate for serverless framework applications","archived":false,"fork":false,"pushed_at":"2024-05-24T11:35:17.000Z","size":34036,"stargazers_count":51,"open_issues_count":1,"forks_count":13,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-26T16:43:59.988Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheSoftwareHouse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2020-10-29T15:21:58.000Z","updated_at":"2024-10-30T10:53:11.000Z","dependencies_parsed_at":"2024-04-19T15:07:45.948Z","dependency_job_id":null,"html_url":"https://github.com/TheSoftwareHouse/serverless-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/TheSoftwareHouse%2Fserverless-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSoftwareHouse%2Fserverless-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSoftwareHouse%2Fserverless-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSoftwareHouse%2Fserverless-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheSoftwareHouse","download_url":"https://codeload.github.com/TheSoftwareHouse/serverless-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251966431,"owners_count":21672666,"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-12T14:03:19.374Z","updated_at":"2025-05-02T00:31:18.071Z","avatar_url":"https://github.com/TheSoftwareHouse.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n \u003cimg src=\"data/logo.svg\" alt=\"\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n   Current travis build:\n  \u003ca href=\"https://travis-ci.com/TheSoftwareHouse/serverless-boilerplate\"\u003e\u003cimg src=\"https://travis-ci.com/TheSoftwareHouse/serverless-boilerplate.svg?branch=master\" alt=\"build status\" height=\"18\"\u003e\u003c/a\u003e\n  \u0026emsp;\n\u003c/p\u003e\n\n##\n\nBoilerplate code for rapidly creating ready-to-deploy Serverless Framework services.\n\n##\n\n### Quick Start\n\n- **Install**\n\n```\nnpm install\n```\n\nrename .env.dist to .env, fill all information\n\n- **Create lambda or workflow**\n\n```\nnpm run plop\n```\n\n##\n\n### Development Local\n\n- docker-compose up\n- npm install\n- rename .env.dist to .env\n- fill all information\n- npm run run-migrations\n- npm run dev\n\n### Debugging locally\n\nServerless uses workers to run lambdas locally. To debug them in your IDE you need to add `--useInProcess` flag, or run the following command:\n\n```\nnpm run dev-with-debug\n```\n\n##\n\n### Run workflow locally\n\n```\nnpm run start-workflow --workflow=NAME_OF_THE_WORKFLOW\n```\n\n### Follow workflow logs\n\nTo follow all the logs from the step function executions you can use the command:\n\n```\nnpm run get-sf-logs\n```\n\n##\n\n### Develop workflow\n\nWe support ASL for Step Functions. Make sure to install AWS Toolkit so you can render graph for step functions and validate its syntax easily.\n\n##\n\n### SonarQube configuration\n\nBefore deployment, please ensure that a related SonarQube project has been created. After that set proper repository variables (`SONAR_TOKEN` and `SONAR_HOST_URL`) and properties in `sonar-project.properties` file. \n\n##\n\n### Deploy\n\nThe best choice for deployment is the bitbucket pipeline.\n\nDeployment [pipeline](bitbucket-pipelines.yml) consist of two steps:\n\n1. compile (automated start)\n   - build\n   - run lambda offline\n   - run test\n2. deploy (user action required)\n\n##\n\n### Other good source of information\n\n- https://serverless.com/framework/docs/providers/aws/guide/variables/\n- https://serverless.com/framework/docs/providers/aws/cli-reference/config-credentials/\n\n##\n\n### What do we use for testing lambdas?\n\n1. [supertest](https://github.com/visionmedia/supertest#readme)\n1. [mocha](https://mochajs.org/)\n\nHere you can check example tests: [handler.spec.ts](functions/example-lambda/tests/handler.spec.ts)\n\n##\n\n### What do we use for validating schemas?\n\nWe use [zod](https://zod.dev/) for schema validation.\n\n##\n\n### **Issues:**\n\nIf you notice any issues while using, let as know on **[github](https://github.com/TheSoftwareHouse/serverless-boilerplate/issues)**.\nSecurity issues, please send on \u003ca href=\"mailto:security.opensource@tsh.io\"\u003e\u003cb\u003eemail\u003c/b\u003e\u003c/a\u003e\n\n### **You may also like our other projects:**\n\n- **[RAD Modules](https://github.com/TheSoftwareHouse/rad-modules)**\n- **[RAD Modules Tools](https://github.com/TheSoftwareHouse/rad-modules-tools)**\n- **[Kakunin](https://github.com/TheSoftwareHouse/Kakunin)**\n- **[Babelsheet-js](https://github.com/TheSoftwareHouse/babelsheet-js)**\n- **[Fogger](https://github.com/TheSoftwareHouse/fogger)**\n\n### **About us:**\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://tsh.io/pl\"\u003e\u003cb\u003eThe Software House\u003c/b\u003e\u003c/a\u003e\n  \u0026emsp;\n  \u003cimg src=\"data/tsh.png\" alt=\"tsh.png\" width=\"50\" /\u003e\n\u003c/p\u003e\n\n##\n\n### License\n\n[![license](https://img.shields.io/badge/license-MIT-4dc71f.svg)](https://raw.githubusercontent.com/TheSoftwareHouse/serverless-boilerplate/main/LICENSE)\n\nThis project is licensed under the terms of the [MIT license](/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthesoftwarehouse%2Fserverless-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthesoftwarehouse%2Fserverless-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthesoftwarehouse%2Fserverless-boilerplate/lists"}