{"id":13626585,"url":"https://github.com/lemoncloud-io/lemon-hello-api","last_synced_at":"2026-02-27T21:05:35.767Z","repository":{"id":35022773,"uuid":"165013619","full_name":"lemoncloud-io/lemon-hello-api","owner":"lemoncloud-io","description":"Simple Serverless API to send message to Slack","archived":false,"fork":false,"pushed_at":"2025-12-16T12:06:15.000Z","size":9247,"stargazers_count":8,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-12-19T18:31:23.404Z","etag":null,"topics":["cloudwatch-alarms","lambda","microservice","nodejs","serverless","slack-webhook","sns-notifications"],"latest_commit_sha":null,"homepage":"","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/lemoncloud-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-01-10T07:40:22.000Z","updated_at":"2025-12-16T07:00:58.000Z","dependencies_parsed_at":"2023-12-06T03:00:18.826Z","dependency_job_id":"a1bf0dea-be6a-4992-b124-c4ba9124857f","html_url":"https://github.com/lemoncloud-io/lemon-hello-api","commit_stats":{"total_commits":305,"total_committers":6,"mean_commits":"50.833333333333336","dds":"0.12786885245901636","last_synced_commit":"f6e781d99b713f908892e0a6309697ec417b5219"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/lemoncloud-io/lemon-hello-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemoncloud-io%2Flemon-hello-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemoncloud-io%2Flemon-hello-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemoncloud-io%2Flemon-hello-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemoncloud-io%2Flemon-hello-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lemoncloud-io","download_url":"https://codeload.github.com/lemoncloud-io/lemon-hello-api/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemoncloud-io%2Flemon-hello-api/sbom","scorecard":{"id":583975,"data":{"date":"2025-08-11","repo":{"name":"github.com/lemoncloud-io/lemon-hello-api","commit":"c55e882a8c213558fd084dbbf7c31fa975370c8c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/24 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 7 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"12 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pppg-cpfq-h7wr","Warn: Project is vulnerable to: GHSA-hw8r-x6gr-5gjp","Warn: Project is vulnerable to: GHSA-44fp-w29j-9vj5","Warn: Project is vulnerable to: GHSA-4pg4-qvpc-4q3h","Warn: Project is vulnerable to: GHSA-g5hg-p3ph-g8qg","Warn: Project is vulnerable to: GHSA-fjgf-rc76-4x9p","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T19:56:20.755Z","repository_id":35022773,"created_at":"2025-08-20T19:56:20.755Z","updated_at":"2025-08-20T19:56:20.755Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29913785,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"ssl_error","status_checked_at":"2026-02-27T19:37:41.463Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["cloudwatch-alarms","lambda","microservice","nodejs","serverless","slack-webhook","sns-notifications"],"created_at":"2024-08-01T21:02:24.345Z","updated_at":"2026-02-27T21:05:35.732Z","avatar_url":"https://github.com/lemoncloud-io.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"[![travis](https://travis-ci.org/lemoncloud-io/lemon-hello-api.svg?branch=master)](https://travis-ci.org/lemoncloud-io/lemon-hello-api)\n[![codecov](https://codecov.io/gh/lemoncloud-io/lemon-hello-api/branch/master/graph/badge.svg)](https://codecov.io/gh/lemoncloud-io/lemon-hello-api)\n[![npm version](https://badge.fury.io/js/lemon-hello-api.svg)](https://badge.fury.io/js/lemon-hello-api)\n[![GitHub version](https://badge.fury.io/gh/lemoncloud-io%2Flemon-hello-api.svg)](https://badge.fury.io/gh/lemoncloud-io%2Flemon-hello-api)\n\n# lemon-hello-api\n\nSimple Serverless MicroService API with `Lambda` + `API Gateway` + `Web Socket` + `SNS` + `SQS` + `KMS`, and `DynamoDB`.\n\n- Sample DevOps with `babel` + `eslint` + `jest` + `supertest` + `codecov` + `travis`\n\n- Sample Integrated with `Slack` + `CloudWatch Alarm`\n\n\n## Description\n\n- Standard devops by lemon based on `Nodejs` + `Typescript`\n- Support sending message to `Slack` from AWS CloudWatch. (see `lemon-hello-sns` AWS SNS after deploying)\n- Save slack message to `S3` bucket as json object\n- Use `DynamoDB` to manage the route-rules per each channels.\n\n\n## Usage\n\n- Fork and Customize the code, and run `npm install`\n\n    ```bash\n    # STEP.1 install packages. (using ci)\n    $ npm ci\n    # STEP.2 customize profile in env/\u003cprofile\u003e.yml\n    # STEP.3 add profile infor to env/config.js\n    # STEP.4 deploy into your AWS account.\n    $ npm run deploy\n    ```\n\n\n- **Example** Screenshot of `slack` when receiving message.\n\n    ![SlackError](assets/sns.report-error.png)\n\n\n## Installation\n\n**[Overrall]**\n\n1. Copy and customise the main config files: `env/lemon.yml`, `env/config.js`\n1. Change `SLACK_PUBLIC` address by slack webhook.\n1. Encrypt `slack` webhook url with `KMS`, and update `SLACK_PUBLIC`\n1. Deploy to AWS cloud `$ npm run deploy`\n1. Enjoy~\n\n\n### STEP.1 How to encrypt string by KMS\n\n- Create master kms-id for 1st time (at first time).\n\n    ```bash\n    # create initial master-key in KMS (example)\n    $ aws kms create-key --profile \u003cprofile\u003e --description 'hello master key'\n    {\n        \"KeyMetadata\": {\n            \"KeyId\": \"0039d20d-112233445566-387b887b4783\",\n        }\n    }\n    # create Alias as `lemon-hello-api`\n    $ aws kms create-alias --profile \u003cprofile\u003e --alias-name alias/lemon-hello-api --target-key-id 0039d20d-112233445566-387b887b4783\n    ```\n\n- Test encryptioin with KMS\n\n    ```sh\n    # run encrypt\n    $ aws kms encrypt --profile \u003cprofile\u003e --key-id alias/lemon-hello-api --cli-binary-format raw-in-base64-out --plaintext \"hello lemon\" --query CiphertextBlob --output text\n    ```\n\n### STEP.2 Deploy to AWS Cloud\n\n- Make AWS Lambda, and API Endpoint with `serverless`\n\n    ```bash\n    # run npm command (if profile is `lemon`, or make your own script)\n    $ npm run deploy.lemon\n    ```\n\n## Development\n\n- Run for local development.\n\n    ```bash\n    # run express service in local (if profile is `lemon`, or make your own script)\n    $ npm run express.lemon\n\n    # test encrypt via api\n    $ http ':8888/hello/0/test-encrypt'    \n    ```\n\n## Support Auto-Build with Travis\n\n- Get NPM Token via [tokens](https://www.npmjs.com/settings/stevelemon/tokens)\n\n```bash\n# install travis-cli (MacOS)\n$ brew install travis\n\n# encrypt npm token\n$ travis encrypt \u003cNPM Token\u003e --add deploy.api_key\n```\n\n## How to Contribute\n\n- request via `PR`, or use `Issue`.\n\n\n## LICENSE\n\n[MIT](http://opensource.org/licenses/MIT)\n\n\n----------------\n# TODO #\n\n- [ ] support dummy restfull api w/ dummy-storage.\n\n\n----------------\n# VERSION INFO #\n\nVersion History\n\n| Version   | Description\n|--         |--\n| 2.4.3     | optimized with `lemon-core#3.2.5`, and cleanup.\n| 2.4.2     | optimized with `lemon-core#3.2.4`, and cleanup.\n| 2.4.0     | use `DynamoDB` to manage route-rules.\n| 2.3.2     | optimized with `lemon-core#3.1.2`, and `nodejs16` runtime.\n| 2.3.1     | optimized with `lemon-core#3.1.1`.\n| 2.2.3     | optimized `notification` message.\n| 2.2.2     | use `direct` to post slack hook directly.\n| 2.1.4     | optimized with `lemon-core#2.1.4`.\n| 1.3.1     | refactoring with [lemon-core](/lemoncloud-io/lemon-core).\n| 1.2.3     | fix: iota of `NS` in sns-service.\n| 1.1.0     | Release version with `npm run release`.\n| 1.0.3     | support `SQS` with handling SQS message.\n| 1.0.2     | support `WSS` with API Gateway + WebSocket.\n| 1.0.1     | support `SNS` with CloudWatch Event, and post to `Slack`\n| 1.0.0     | initial version with full deploy by profile+stage\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flemoncloud-io%2Flemon-hello-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flemoncloud-io%2Flemon-hello-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flemoncloud-io%2Flemon-hello-api/lists"}