{"id":15776419,"url":"https://github.com/devigned/sample-devex-bot","last_synced_at":"2025-03-31T15:20:29.604Z","repository":{"id":145071786,"uuid":"85860919","full_name":"devigned/sample-devex-bot","owner":"devigned","description":null,"archived":false,"fork":false,"pushed_at":"2017-03-30T22:27:32.000Z","size":26,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-05T17:21:26.358Z","etag":null,"topics":[],"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/devigned.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":"2017-03-22T18:10:48.000Z","updated_at":"2017-03-25T01:14:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"44ca952b-55cc-4f69-9eec-dee57917a819","html_url":"https://github.com/devigned/sample-devex-bot","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/devigned%2Fsample-devex-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devigned%2Fsample-devex-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devigned%2Fsample-devex-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devigned%2Fsample-devex-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devigned","download_url":"https://codeload.github.com/devigned/sample-devex-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246489458,"owners_count":20785881,"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-10-04T17:21:37.626Z","updated_at":"2025-03-31T15:20:29.569Z","avatar_url":"https://github.com/devigned.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sample-devex-bot\n\nsample-devex-bot is a chat bot built on the [Hubot][hubot] framework. It was\ninitially generated by [generator-hubot][generator-hubot], and configured to be\ndeployed on [Heroku][heroku] to get you up and running as quick as possible.\n\nThis README is intended to help get you started. Definitely update and improve\nto talk about your own instance, how to use and deploy, what functionality is\navailable, etc!\n\n[hubot]: http://hubot.github.com\n\n### Running sample-devex-bot Locally\n\nYou can test your hubot by running the following, however some plugins will not\nbehave as expected unless the [environment variables](#configuration) they rely\nupon have been set.\n\nYou can start sample-devex-bot locally by running:\n\n    % bin/hubot\n\nYou'll see some start up output and a prompt:\n\n    [Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379\n    sample-devex-bot\u003e\n\nThen you can interact with sample-devex-bot by typing `sample-devex-bot help`.\n\n    sample-devex-bot\u003e sample-devex-bot help\n    sample-devex-bot animate me \u003cquery\u003e - The same thing as `image me`, except adds [snip]\n    sample-devex-bot help - Displays all of the help commands that sample-devex-bot knows about.\n    ...\n\n### Configuration\n\nA few scripts (including some installed by default) require environment\nvariables to be set as a simple form of configuration.\n\nEach script should have a commented header which contains a \"Configuration\"\nsection that explains which values it requires to be placed in which variable.\nWhen you have lots of scripts installed this process can be quite labour\nintensive. The following shell command can be used as a stop gap until an\neasier way to do this has been implemented.\n\n    grep -o 'hubot-[a-z0-9_-]\\+' external-scripts.json | \\\n      xargs -n1 -I {} sh -c 'sed -n \"/^# Configuration/,/^#$/ s/^/{} /p\" \\\n          $(find node_modules/{}/ -name \"*.coffee\")' | \\\n        awk -F '#' '{ printf \"%-25s %s\\n\", $1, $2 }'\n\nHow to set environment variables will be specific to your operating system.\nRather than recreate the various methods and best practices in achieving this,\nit's suggested that you search for a dedicated guide focused on your OS.\n\n### Scripting\n\nAn example script is included at `scripts/example.coffee`, so check it out to\nget started, along with the [Scripting Guide][scripting-docs].\n\nFor many common tasks, there's a good chance someone has already one to do just\nthe thing.\n\n[scripting-docs]: https://github.com/github/hubot/blob/master/docs/scripting.md\n\n### external-scripts\n\nThere will inevitably be functionality that everyone will want. Instead of\nwriting it yourself, you can use existing plugins.\n\nHubot is able to load plugins from third-party `npm` packages. This is the\nrecommended way to add functionality to your hubot. You can get a list of\navailable hubot plugins on [npmjs.com][npmjs] or by using `npm search`:\n\n    % npm search hubot-scripts panda\n    NAME             DESCRIPTION                        AUTHOR DATE       VERSION KEYWORDS\n    hubot-pandapanda a hubot script for panda responses =missu 2014-11-30 0.9.2   hubot hubot-scripts panda\n    ...\n\n\nTo use a package, check the package's documentation, but in general it is:\n\n1. Use `npm install --save` to add the package to `package.json` and install it\n2. Add the package name to `external-scripts.json` as a double quoted string\n\nYou can review `external-scripts.json` to see what is included by default.\n\n##### Advanced Usage\n\nIt is also possible to define `external-scripts.json` as an object to\nexplicitly specify which scripts from a package should be included. The example\nbelow, for example, will only activate two of the six available scripts inside\nthe `hubot-fun` plugin, but all four of those in `hubot-auto-deploy`.\n\n```json\n{\n  \"hubot-fun\": [\n    \"crazy\",\n    \"thanks\"\n  ],\n  \"hubot-auto-deploy\": \"*\"\n}\n```\n\n**Be aware that not all plugins support this usage and will typically fallback\nto including all scripts.**\n\n[npmjs]: https://www.npmjs.com\n\n### hubot-scripts\n\nBefore hubot plugin packages were adopted, most plugins were held in the\n[hubot-scripts][hubot-scripts] package. Some of these plugins have yet to be\nmigrated to their own packages. They can still be used but the setup is a bit\ndifferent.\n\nTo enable scripts from the hubot-scripts package, add the script name with\nextension as a double quoted string to the `hubot-scripts.json` file in this\nrepo.\n\n[hubot-scripts]: https://github.com/github/hubot-scripts\n\n## Adapters\n\nAdapters are the interface to the service you want your hubot to run on, such\nas Campfire or IRC. There are a number of third party adapters that the\ncommunity have contributed. Check [Hubot Adapters][hubot-adapters] for the\navailable ones.\n\nIf you would like to run a non-Campfire or shell adapter you will need to add\nthe adapter package as a dependency to the `package.json` file in the\n`dependencies` section.\n\nOnce you've added the dependency with `npm install --save` to install it you\ncan then run hubot with the adapter.\n\n    % bin/hubot -a \u003cadapter\u003e\n\nWhere `\u003cadapter\u003e` is the name of your adapter without the `hubot-` prefix.\n\n[hubot-adapters]: https://github.com/github/hubot/blob/master/docs/adapters.md\n\n## Deployment\n\n### Provisioning\n\nTo run on Azure AppService Linux provision the following:\n\n      $ az group create -n $groupName -l westus\n      $ az appservice plan create -g $groupName -n botplan -l westus --is-linux\n      $ az appservice web create -g $groupName -n $webappName\n      $ az appservice web config container update -c devigned/sallybot\n      $ az appservice web config appsettings update # (with HUBOT_SLACK_TOKEN, DEVEX_CONN_STRING and REDIS_URL)\n      \n### Docker Container Build, Run and Push\n\n      $ docker build -t devigned/sallybot .\n      $ docker run -it -e HUBOT_SLACK_TOKEN=$HUBOT_SLACK_TOKEN \\\n         -e DEVEX_CONN_STRING=$DEVEX_CONN_STRING -e REDIS_URL=$REDIS_URL \\\n         devigned/sallybot\n      $ docker push devigned/sallybot\n      $ az appservice web config container update -c devigned/sallybot:latest\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevigned%2Fsample-devex-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevigned%2Fsample-devex-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevigned%2Fsample-devex-bot/lists"}