{"id":17573777,"url":"https://github.com/zxdong262/ringcentral-welcome-bot-js","last_synced_at":"2025-03-29T15:28:52.095Z","repository":{"id":69414852,"uuid":"176877942","full_name":"zxdong262/ringcentral-welcome-bot-js","owner":"zxdong262","description":"Glip chatbot to welcome new team member","archived":false,"fork":false,"pushed_at":"2019-05-09T07:25:53.000Z","size":51,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-04T16:19:11.798Z","etag":null,"topics":["bot","glip","ringcentral","welcome"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/zxdong262.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,"publiccode":null,"codemeta":null}},"created_at":"2019-03-21T05:45:40.000Z","updated_at":"2020-01-04T13:23:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"32bcc759-6b18-4913-98e3-624910cad64f","html_url":"https://github.com/zxdong262/ringcentral-welcome-bot-js","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/zxdong262%2Fringcentral-welcome-bot-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zxdong262%2Fringcentral-welcome-bot-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zxdong262%2Fringcentral-welcome-bot-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zxdong262%2Fringcentral-welcome-bot-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zxdong262","download_url":"https://codeload.github.com/zxdong262/ringcentral-welcome-bot-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246203328,"owners_count":20740104,"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":["bot","glip","ringcentral","welcome"],"created_at":"2024-10-21T21:04:46.831Z","updated_at":"2025-03-29T15:28:52.064Z","avatar_url":"https://github.com/zxdong262.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# ringcentral-welcome-bot-js\n\nGlip chatbot to welcome new team member, created with [ringcentral-chatbot-factory](https://github.com/zxdong262/ringcentral-chatbot-factory) and [ringcentral-chatbot-js](https://github.com/ringcentral/ringcentral-chatbot-js).\n\n![ ](screenshot/ss.png)\n\n## Prerequisites\n\n- Nodejs 8.10+/npm, recommend using [nvm](https://github.com/creationix/nvm) to install nodejs/npm\n- Yarn (`npm i -g yarn`)\n- Create the bot App: Login to [developer.ringcentral.com](https://developer.ringcentral.com) and create an `public` `Server/Bot` app with permissions: `ReadContacts, ReadMessages, ReadPresence, Contacts, ReadAccounts, SMS, InternalMessages, ReadCallLog, ReadCallRecording, WebhookSubscriptions, Glip`\n\n## Development \u0026 Quick start\n\n```bash\n# install dependencies\nyarn\n\n# run ngrok proxy\n# since bot need https server,\n# so we need a https proxy for ringcentral to visit our local server\nyarn proxy\n# will show:\n# Forwarding https://xxxxx.ngrok.io -\u003e localhost:3000\n\n# create env file\ncp .sample.env .env\n# then edit .env, set proper setting,\n# and goto your ringcentral app setting page, set OAuth Redirect URI to https://https://xxxxx.ngrok.io/bot/oauth\n\n# create bot logic file\n# edit src/bot.js to create your own bot logic\ncp bot-logic.js src/bot.js\n\n# run local dev server\nyarn start\n\n```\n\n## Test bot\n\n- Goto your ringcentral app's bot section, click 'Add to glip'\n- Login to [https://glip-app.devtest.ringcentral.com](https://glip-app.devtest.ringcentral.com), find the bot by searching its name. Talk to the bot.\n- Edit config.py to change bot bahavior and test in [https://glip-app.devtest.ringcentral.com](https://glip-app.devtest.ringcentral.com)\n\n## Building and Deploying to AWS Lambda\n\nAWS Lambda with API Gateway and RDS would give us a flexible way to deploy the bot.\n\nGet an AWS account, create `aws_access_key_id` and `aws_secret_access_key` and place them in `~/.aws/credentials`, like this:\n\n```bash\n[default]\naws_access_key_id = \u003cyour aws_access_key_id\u003e\naws_secret_access_key = \u003cyour aws_secret_access_key\u003e\n```\n\nFor more information, refer to [https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)\n\n```bash\ncp dist/serverless.sample.yml dist/serverless.yml\ncp dist/.env.sample.yml dist/.env.yml\n```\n\n### AWS Lambda connects AWS RDS issue\n\n- If you create an RDS manually and let it create a new security group for you.\n- By default, the security group only allows inbound traffic from your current laptop's public IP address\nAWS Lambda by default cannot access the newly created AWS RDS\n- We need to update security group to allow inbound traffic from 0.0.0.0/0\n\nEdit `dist/serverless.yml` and `dist/.env.yml`, and make sure you set the proper name and required env.\n\nDeploy to AWS Lambda with `yarn build \u0026\u0026 yarn deploy`\n\n```bash\n# build\nyarn build\n\n# Run this cmd to deploy to AWS Lambda, full build, may take more time\nyarn deploy\n\n## watch Lambda server log\nyarn watch\n\n```\n\nDo not forget to set your RingCentral app's redirect URL to Lambda's API Gateway URL, `https://xxxx.execute-api.us-east-1.amazonaws.com/prod/bot/oauth` for bot app.\n\n## License\n\nMIT\n  ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzxdong262%2Fringcentral-welcome-bot-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzxdong262%2Fringcentral-welcome-bot-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzxdong262%2Fringcentral-welcome-bot-js/lists"}