{"id":16584894,"url":"https://github.com/mikaelvesavuori/serverless-starter","last_synced_at":"2025-03-06T05:16:34.536Z","repository":{"id":101082322,"uuid":"584713467","full_name":"mikaelvesavuori/serverless-starter","owner":"mikaelvesavuori","description":"Helps you kickstart your serverless thingamajing.","archived":false,"fork":false,"pushed_at":"2023-01-04T08:48:22.000Z","size":258,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-16T16:22:28.796Z","etag":null,"topics":["boilerplate","demo","serverless","starter","template"],"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/mikaelvesavuori.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":"2023-01-03T10:21:54.000Z","updated_at":"2023-01-03T10:24:23.000Z","dependencies_parsed_at":"2023-09-16T22:46:03.569Z","dependency_job_id":null,"html_url":"https://github.com/mikaelvesavuori/serverless-starter","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/mikaelvesavuori%2Fserverless-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikaelvesavuori%2Fserverless-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikaelvesavuori%2Fserverless-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikaelvesavuori%2Fserverless-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikaelvesavuori","download_url":"https://codeload.github.com/mikaelvesavuori/serverless-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242150810,"owners_count":20080007,"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":["boilerplate","demo","serverless","starter","template"],"created_at":"2024-10-11T22:46:08.690Z","updated_at":"2025-03-06T05:16:34.527Z","avatar_url":"https://github.com/mikaelvesavuori.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Product name\n\n| Product name | Team     | Owner       | Tech lead          | Some link                | Lifecycle stage | Tags    |\n| ------------ | -------- | ----------- | ------------------ | ------------------------ | --------------- | ------- |\n| My product   | ThatTeam | Cassie Cash | Someguy Someguyson | https://company.com/asdf | Production      | backend |\n\n## Quickstart\n\nWrite an easy-to-follow guide or onboarding material for new users to help them quickly do something with the software.\n\n### Commands\n\nList your most important commands here.\n\n#### Start development server\n\n```shell\nnpm start\n```\n\nDescription here.\n\n### Configurations to edit\n\nConfigurations that are required and/or can be edited, including for initial setup, if necessary.\n\n### Endpoints\n\n- Development endpoint: [Link]()\n- Staging endpoint: [Link]()\n- Production endpoint: [Link]()\n\n## Online documentation\n\nOur online documentation can be found at:\n\n- Website\n- API docs\n- Confluence (add link)\n\n## Source code\n\nSource code for our repositories can be found at:\n\n- Location 1 (add link)\n- Location 2 (add link)\n\n## Diagrams\n\nPlease see the `diagrams` folder.\n\n### Application code diagram\n\n![Application code diagram](code-diagram.svg)\n\n### Infrastructure diagram\n\n![Infrastructure diagram](cfn-diagram.png)\n\n### Architectural Decision Records\n\nWe follow the Michael Nygard model for Architectural Decision Records.\nPlease see the `adr` folder.\n\n## API contracts, interfaces and event catalog\n\nVisit the docs on Bump or see the `api` folder.\n\n### Example payloads\n\nProvide example payloads for all types of API requests or events that your system handles.\n\n#### Do something\n\nDescription.\n\n##### Input\n\n```\nPOST /doSomething\n\n{\n  \"key\": \"value\"\n}\n```\n\n##### Output\n\n```\nStatus 200\n\n{\n  \"key\": \"value\"\n}\n```\n\n### Events\n\n#### SomethingHappened\n\nDescription.\n\n##### Schema\n\n```\n{\n \"key\": \"value\"\n}\n```\n\n## Tests and validation\n\nSpecify how to run tests and describe what types of tests are conducted. Also, specify any manual validations that might be needed and how to do them.\n\n## Technical design of the solution\n\nWrite how you have designed your solution, for example in terms of technical scaling, databases, network segregation, and so on. See SDLC safeguards section 2 for more on these requirements.\n\n### Explicit or implicit non-functional requirements\n\nSomething here.\n\n### Technical scaling and performance\n\nSomething here.\n\n### Resiliency and reliability\n\nSomething here.\n\n### Access management\n\nSomething here.\n\n#### Authentication and authorization\n\nSomething here.\n\n### Data retention and sensitivity\n\nSomething here. For more, see `Data Inventory` section above.\n\n### Cost\n\nSomething here.\n\n### Operational effectiveness\n\nSomething here.\n\n## Observability\n\n### Logging\n\nWhat information does this service log?\nLink to logs/log group.\n\n### Dashboards and metrics\n\nWhich dashboards exist? Is it easy to determine whether or not this microservice is working correctly by looking at the dashboard?\nLink to dashboards.\n\n### Key metrics\n\nWhat are this microservice's key metrics?\n\n**Example metrics**\n\n- Language-specific metrics\n- Availability\n- SLA\n- Latency\n- Endpoint success/responses/response times\n- Clients\n- Errors and exceptions\n- Dependencies\n\n### Alerts\n\nWhat alerts exist? Where do they report, on what thresholds? To whom? At what intervals?\n\n## Changelog\n\nSee `CHANGELOG.md`. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/CHANGELOG.md\n\n## Bug and vulnerability reporting\n\nWe have a risk-based remediation strategy, with monthly, or more frequent, reviews. We use the CVSS framework to prioritize the order in which discovered vulnerabilities are fixed.\n\nWe use the following software tooling/products/services to aid us in our work:\n\n- Some Product\n\nPlease see `SECURITY.md` for more. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/SECURITY.md\n\n## Contribution guidelines and code review process\n\nPlease see `CONTRIBUTING.md`. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/CONTRIBUTING.md\n\n## Code of conduct\n\nPlease see `CODE_OF_CONDUCT.md`. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/CODE_OF_CONDUCT.md\n\n## License\n\nPlease see `LICENSE.md`. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/LICENSE.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikaelvesavuori%2Fserverless-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikaelvesavuori%2Fserverless-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikaelvesavuori%2Fserverless-starter/lists"}