{"id":19786695,"url":"https://github.com/vivid-lapin/ibm-cloud-functions-typescript-template","last_synced_at":"2025-10-15T11:18:47.490Z","repository":{"id":183014368,"uuid":"397607055","full_name":"vivid-lapin/ibm-cloud-functions-typescript-template","owner":"vivid-lapin","description":"Template for IBM Cloud Functions with TypeScript and webpack.","archived":false,"fork":false,"pushed_at":"2022-05-10T06:14:25.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-28T14:05:27.245Z","etag":null,"topics":["ibm-cloud","ibm-cloud-functions","openwhisk","openwhisk-sample","typescript","webpack"],"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/vivid-lapin.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}},"created_at":"2021-08-18T13:16:28.000Z","updated_at":"2022-05-10T06:10:53.000Z","dependencies_parsed_at":"2023-07-22T13:00:39.879Z","dependency_job_id":null,"html_url":"https://github.com/vivid-lapin/ibm-cloud-functions-typescript-template","commit_stats":null,"previous_names":["vivid-lapin/ibm-cloud-functions-typescript-template"],"tags_count":0,"template":true,"template_full_name":"vivid-lapin/ibm-cloud-functions-typescript-rollup","purl":"pkg:github/vivid-lapin/ibm-cloud-functions-typescript-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vivid-lapin%2Fibm-cloud-functions-typescript-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vivid-lapin%2Fibm-cloud-functions-typescript-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vivid-lapin%2Fibm-cloud-functions-typescript-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vivid-lapin%2Fibm-cloud-functions-typescript-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vivid-lapin","download_url":"https://codeload.github.com/vivid-lapin/ibm-cloud-functions-typescript-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vivid-lapin%2Fibm-cloud-functions-typescript-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279076272,"owners_count":26098127,"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","status":"online","status_checked_at":"2025-10-15T02:00:07.814Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["ibm-cloud","ibm-cloud-functions","openwhisk","openwhisk-sample","typescript","webpack"],"created_at":"2024-11-12T06:19:06.434Z","updated_at":"2025-10-15T11:18:47.451Z","avatar_url":"https://github.com/vivid-lapin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [ibm-cloud-functions-typescript-template](https://github.com/vivid-lapin/ibm-cloud-functions-typescript-template)\n\nTemplate for IBM Cloud Functions with TypeScript and webpack.\n\n## How to use\n\n1. Register [IBM Cloud Lite](https://cloud.ibm.com/registration/startUpgradeToLite)\n   - Get API Key on [https://cloud.ibm.com/iam/apikeys](https://cloud.ibm.com/iam/apikeys).\n1. Install `ibmcloud` cli \u0026 login\n   ```bash\n   brew install ibm-cloud-cli\n   # it conflicts with /Application/Docker.app that not installed by brew cask\n   ibmcloud plugin install cloud-functions\n   ibmcloud login --apikey \u003cAPIKEY\u003e\n   ibmcloud resource groups\n   ibmcloud target -g \u003cdefault group id\u003e\n   ibmcloud fn namespace list\n   ibmcloud fn namespace target \u003cnamespace which u want to use\u003e\n   ```\n1. Use [this template](https://github.com/vivid-lapin/ibm-cloud-functions-typescript-template) and clone a repository\n   ```bash\n   git clone \u003cyour generated repo\u003e\n   cd reponame\n   ```\n1. Build \u0026 deploy\n   ```bash\n   yarn\n   yarn build\n   ```\n1. Install direnv and make `.envrc` and apply\n   ```bash\n   brew install direnv\n   # follow intro like add a line to .zshrc\n   touch .envrc\n   ```\n   `.envrc`:\n   ```env\n   export WEBHOOK_URL='your discord webhook url'\n   export TARGET_ACTION_NAME='/1111-2222-3333/test/webhook'\n   ```\n   ```bash\n   direnv allow .\n   ```\n1. Deploy\n   ```bash\n   yarn deploy\n   # $ ibmcloud fn deploy --manifest manifest.yaml\n   # Success: Deployment completed successfully.\n   ```\n1. Enjoy!\n\n### Tips: Call an action from other action\n\nAfter deploying, check the name of the action with the following command:\n\n```bash\nibmcloud fn package list\n# packages\n# /aaaa-bbbb-dddd-8226-aaaa/test                             private\n#  ^ test's project name\nibmcloud fn action list /aaaa-bbbb-dddd-8226-aaaa/test\n# actions\n# /aaaa-bbbb-dddd-8226-aaaa/test/test                  private nodejs:12\n#  ^ action's name\n```\n\nIn this case, `/aaaa-bbbb-dddd-8226-aaaa/test/test` is action's name.\u003cbr /\u003e\nTo deploy, rewrite `.envrc` as\n\n```env\nexport TARGET_ACTION_NAME=\"/aaaa-bbbb-dddd-8226-aaaa/test/test\"\n```\n\nAnd,\n\n```bash\ndirenv allow .\nyarn deploy\n```\n\n### Customize manifest.yaml\n\nRead [https://github.com/apache/openwhisk-wskdeploy/tree/master/specification/html](https://github.com/apache/openwhisk-wskdeploy/tree/master/specification/html).\n\n## Reference\n\n- (Japanese) [IBM Cloud Functions の Action/Trigger/Rule を yaml ファイル一発でデプロイする - Qiita](https://qiita.com/khayama/items/dd81cb137d44dd1e5332)\n- [Hands on IBM Cloud Functions with CLI | inDev. Journal](https://frankindev.com/2020/10/20/hands-on-ibm-cloud-functions/)\n  - `ibmcloud iam service ids` =\u003e `ibmcloud iam service-ids`\n- (Japanese) [IBM Cloud Functions でバックグラウンド処理をする 2021 年 8 月版](https://scrapbox.io/ci7lus/IBM_Cloud_Functions%E3%81%A7%E3%83%90%E3%83%83%E3%82%AF%E3%82%B0%E3%83%A9%E3%82%A6%E3%83%B3%E3%83%89%E5%87%A6%E7%90%86%E3%82%92%E3%81%99%E3%82%8B2021%E5%B9%B48%E6%9C%88%E7%89%88)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvivid-lapin%2Fibm-cloud-functions-typescript-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvivid-lapin%2Fibm-cloud-functions-typescript-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvivid-lapin%2Fibm-cloud-functions-typescript-template/lists"}