hubot-stride
Advanced tools
hubot-stride - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
| { | ||
| "name": "hubot-stride", | ||
| "version": "1.0.0", | ||
| "version": "1.0.1", | ||
| "description": "Hubot adapter for Atlassian Stride", | ||
@@ -18,3 +18,7 @@ "main": "lib/web.js", | ||
| }, | ||
| "keywords": ["hubot", "stride", "adapter"], | ||
| "keywords": [ | ||
| "hubot", | ||
| "stride", | ||
| "adapter" | ||
| ], | ||
| "author": "", | ||
@@ -21,0 +25,0 @@ "license": "MIT", |
| # hubot-stride | ||
| [Hubot](https://hubot.github.com/) adapter for [Atlassian Stride](https://www.stride.com/) | ||
| ## How to set up | ||
| Be sure to have [node.js >= 8.0.0](https://nodejs.org/en/) and [ngrok](https://ngrok.com/) installed. You will also need [Yeoman](http://yeoman.io/) and [Hubot generator](https://github.com/hubotio/generator-hubot): | ||
| ## Prerequisites | ||
| You need to install: | ||
| * [node.js >= 8.0.0](https://nodejs.org/en/) | ||
| * [ngrok](https://ngrok.com/) | ||
| * [Yeoman](http://yeoman.io/) | ||
| * [Hubot generator](https://github.com/hubotio/generator-hubot): | ||
| ``` | ||
| npm install -g yo generator-hubot | ||
| ``` | ||
| ### Generate Hubot project | ||
| ### Generate the Hubot project | ||
| ``` | ||
@@ -15,3 +20,3 @@ mkdir myhubot | ||
| ``` | ||
| ### Create an app | ||
| ### Create a Stride app | ||
@@ -27,5 +32,5 @@ Next, [create a Stride app](https://developer.atlassian.com/apps/create) in developer.atlassian.com | ||
| * In the **Enabled APIs** tab, make a note of the client ID and the client secret. | ||
| * In the **App Features** tab, enable Bot account and make note of the Mention name | ||
| * In the **App Features** tab, enable Bot account and make note of the **bot mention name** | ||
| ### Configure | ||
| ### Configure the Hubot adapter | ||
@@ -39,8 +44,9 @@ You will need to tell adapter its name and credentials: | ||
| **Make sure HUBOT_NAME matches the bot mention name for the Stride app**, | ||
| otherwise mentioning the bot in Stride won't work. | ||
| ### Start ngrok | ||
| Install [Ngrok](https://ngrok.com/) if you don't already have it. | ||
| ``` | ||
| //new tab start ngrok and leave running | ||
| //start ngrok and leave running | ||
| ngrok http 8000 | ||
@@ -55,3 +61,3 @@ ``` | ||
| ``` | ||
| To verify if your bot works correctly, load the following URL in your browser: | ||
| To verify if your Stride app works correctly, load the following URL in your browser: | ||
@@ -62,3 +68,3 @@ ``` | ||
| ### Update the descriptor in Stride | ||
| ### Update the Stride app descriptor in Stride | ||
@@ -73,7 +79,7 @@ * Navigate to your [My Apps](https://developer.atlassian.com/apps) page. | ||
| Your app is created and configured, and your app descriptor is linked. Now, you can add the app to a conversation: | ||
| Your app is created and configured, and your app descriptor is linked. Now, you need to add the app to a conversation: | ||
| * In your app dashboard, in the **Install** tab, click **Copy** for the Installation URL. | ||
| * Open Stride. | ||
| * Open the conversation in which you’d like to install the app. | ||
| * Open the conversation in which you’d like to install the app. | ||
| * Click the **Apps** icon to open the Apps sidebar, and then click the + button to open the Atlassian Marketplace in Stride. | ||
@@ -84,2 +90,4 @@ * Click **Connect your app** in the **Connect your own app** box, and then select the **Installation URL** tab. | ||
| For subsequent installations, users just have to mention the bot in any room. | ||
| ## Contributing | ||
@@ -92,9 +100,11 @@ If you wish to contribute to this project, you first need to clone this repository. Installing dependencies: | ||
| ``` | ||
| Now you need to perform all the steps from the previous sections except that you do not need to generate a project, and to run you bot, instead of using `./bin/hubot --adapter stride` you should use: | ||
| Now you need to perform all the steps from the previous sections except that you do not need to generate a project. | ||
| To run you bot, instead of using `./bin/hubot --adapter stride` you should use: | ||
| ``` | ||
| npm start | ||
| ``` | ||
| If you want to run API tests: | ||
| To run API tests: | ||
| ``` | ||
| npm test | ||
| ``` |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.47%
35247
- Number of lines in readme file
- increased by10.87%
102